{ "openapi": "3.0.0", "info": { "title": "inwendo ERP API", "description": "### License and Disclaimers:\n\nUsers are permitted to use and modify our public REST APIs to facilitate their use of the inwendo ERP in a manner consistent with the rights they\u2019ve separately purchased from inwendo, during the term of their license or subscription.\n\nWe do not make any guarantees, representations or other warranties with respect to our public REST APIs or any improvements. In addition, we do not provide any particular support with respect to our public REST APIs, unless we\u2019ve otherwise agreed to do so in writing.\n\n### Backward Compatibility and Limitations:\n\nThe last thing developers and businesses need is to be surprised that a crucial endpoint is no longer reachable, behaving unexpectedly, or has changed in any way that disrupts or breaks an established workflow. We take steps designed to ensure backwards compatibility of our APIs.\n\nWe consider the following changes to be backwards-compatible:\n\n#### Additive changes:\n\n \u2022 Adding a new resource (i.e. adding a new URL or path to the APIs)\n\n \u2022 Adding new optional request parameters\n\n \u2022 Adding new JSON fields in API responses\n\n \u2022 Changing the length or format of strings in error messages\n\n\n#### Limits and Constraints:\n\n \u2022 Your API client consumer should gracefully handle any of the additive changes above.\n\n \u2022 inwendo might apply sensible concurrency and rate limits when the integrity of the inwendo ERP and\/or service degradation is at risk, even if an individual resource has no rate limits currently.\n\n\n#### Versions and Sunsetting:\n\n \u2022 When breaking changes are required to innovate and evolve the inwendo ERP, we will provide version updates for individual APIs as designated by changes to the next whole number -- for example, \/v1\/metrics, \/v2\/metrics, etc.\n", "contact": { "name": "inwendo GmbH", "url": "https:\/\/inwendo.de", "email": "support+erp@inwendo.de" }, "version": "2026101021" }, "servers": [ { "url": "https:\/\/replace-with-own-host.iw-erp.de" } ], "paths": { "\/api\/logins": { "post": { "tags": [ "Login \/ E-Mail Login" ], "summary": "Do log in with email and password", "operationId": "post_post_login", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "tokenIdentifiers", "in": "query", "description": "JWTs to return with session", "required": false, "schema": { "type": "string", "enum": [ "iw-external", "iw-mqtt", "iw-internal", "firebase", "lanista" ] } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "login": { "$ref": "#\/components\/schemas\/FormLoginUser" } }, "type": "object" } } } }, "responses": { "200": { "description": "Do log in with email and password", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Session" } } } } } } }, "\/api\/logins\/resets": { "post": { "tags": [ "Login \/ E-Mail Login" ], "summary": "Do reset password for email", "operationId": "post_post_login_reset", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "login": { "$ref": "#\/components\/schemas\/FormLoginUser2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Do reset password for email", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/logins\/delete": { "post": { "tags": [ "Login \/ E-Mail Login" ], "summary": "Remove own login - Requires own password", "operationId": "post_delete_login_reset", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "login": { "$ref": "#\/components\/schemas\/FormLoginUser" } }, "type": "object" } } } }, "responses": { "200": { "description": "Remove own login - Requires own password", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/logouts": { "post": { "tags": [ "Login \/ Logout" ], "summary": "Do log out", "operationId": "post_post_logout", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "session": { "$ref": "#\/components\/schemas\/FormSession" } }, "type": "object" } } } }, "responses": { "200": { "description": "Do log out", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/users\/{id}": { "get": { "tags": [ "User \/ User" ], "summary": "This method will get a single User Object with the given id", "operationId": "get_get_user", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "This method will get a single User Object with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User" } } } } } }, "put": { "tags": [ "User \/ User" ], "summary": "This method will update a User Object", "operationId": "put_put_user", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "user": { "$ref": "#\/components\/schemas\/User2" } }, "type": "object" } } } }, "responses": { "200": { "description": "This method will update a User Object", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User14" } } } } } } }, "\/api\/users": { "get": { "tags": [ "User \/ User" ], "summary": "This method will get all User Objects", "operationId": "get_get_users", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "This method will get all User Objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User14" } } } } } } } }, "\/api\/user\/profile": { "get": { "tags": [ "User \/ User" ], "summary": "This method will get your User Object", "operationId": "get_get_user_profile", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "This method will get your User Object", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User14" } } } } } } }, "\/api\/user_access_group": { "get": { "tags": [ "User \/ UserAccessGroup" ], "summary": "Returns a list of UserAccessGroup entries.", "operationId": "get_get_user_access_groups", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Return all UserAccessGroup", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserAccessGroup" } } } } } } }, "post": { "tags": [ "User \/ UserAccessGroup" ], "summary": "Creates a new UserAccessGroup entry.", "operationId": "post_post_user_access_group", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/UpdateUserAccessGroup" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add new UserAccessGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserAccessGroup" } } } } } } }, "\/api\/user_access_group\/{identifier}": { "get": { "tags": [ "User \/ UserAccessGroup" ], "summary": "Return a single UserAccessGroup", "operationId": "get_get_user_access_group", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a single UserAccessGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserAccessGroup" } } } } } }, "put": { "tags": [ "User \/ UserAccessGroup" ], "summary": "Update a single UserAccessGroup", "operationId": "put_put_user_access_group", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/UserAccessGroup" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single UserAccessGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserAccessGroup" } } } } } }, "patch": { "tags": [ "User \/ UserAccessGroup" ], "summary": "Update a single UserAccessGroup", "operationId": "patch_put_user_access_group", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/UserAccessGroup" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single UserAccessGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserAccessGroup" } } } } } } }, "\/api\/sessions": { "get": { "tags": [ "Session \/ Session" ], "summary": "This method will get the active Session Object", "operationId": "get_get_sessions", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "tokenIdentifiers", "in": "query", "description": "JWTs to return with session", "required": false, "schema": { "type": "string", "enum": [ "iw-external", "iw-mqtt", "iw-internal", "firebase", "lanista" ] } }, { "name": "validSeconds", "in": "query", "description": "JWT valid for duration in seconds", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "This method will get the active Session Object", "content": { "application\/json": { "schema": { "oneOf": [ { "$ref": "#\/components\/schemas\/Session2" }, { "$ref": "#\/components\/schemas\/Session3" } ] } } } } } }, "post": { "tags": [ "Session \/ Session" ], "summary": "Update Customer Profile on User", "operationId": "post_post_session", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "switchcustomerprofile": { "$ref": "#\/components\/schemas\/SwitchCustomerProfile" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update Customer Profile on User", "content": { "application\/json": { "schema": { "oneOf": [ { "$ref": "#\/components\/schemas\/Session2" }, { "$ref": "#\/components\/schemas\/Session3" } ] } } } } } } }, "\/api\/sessions\/{serviceName}\/sso": { "get": { "tags": [ "Session \/ Session" ], "summary": "This method will get the sso link with a token - set query parameter durableJwt=1 to get a long-lasting token without the option to login as the user", "operationId": "get_get_session_sso", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "serviceName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "This method will get the sso link with a token - set query parameter durableJwt=1 to get a long-lasting token without the option to login as the user", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpenDataRedirect" } } } } } } }, "\/api\/session\/verify2fa\/{id}\/{code}": { "get": { "tags": [ "Session \/ Session" ], "summary": "Verify 2FA code for this session", "operationId": "get_get_session_verify2fa", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Verify 2FA code for this session", "content": { "application\/json": { "schema": { "oneOf": [ { "$ref": "#\/components\/schemas\/Session2" }, { "$ref": "#\/components\/schemas\/Session3" } ] } } } } } } }, "\/api\/customer\/saldo": { "get": { "tags": [ "Customer \/ Saldo" ], "summary": "Returns the current payment balance (saldo) for the authenticated customer's company.", "operationId": "get_customer_saldo_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the saldo" } } } }, "\/api\/customertickets\/{id}\/satisfaction": { "post": { "tags": [ "Customer \/ Customerticket" ], "summary": "Rate a finished ticket (1 to 5 stars, optional comment) - only when the team asked for it\n(customer_panel_ticket_satisfaction_enabled). A new rating replaces the old one.", "operationId": "post_post_customerticket_satisfaction", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "rating": { "description": "1 (bad) to 5 (very good)", "type": "integer", "example": 5 }, "comment": { "description": "Optional comment", "type": "string", "example": "Schnell und freundlich" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/google\/logins": { "get": { "tags": [ "Social Login \/ Google Login" ], "summary": "Get redirect for google login", "operationId": "get_get_google_logins", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get redirect for google login", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpenDataRedirect" } } } } } } }, "\/api\/googles\/logins": { "post": { "tags": [ "Social Login \/ Google Login" ], "summary": "Do log in with google code", "operationId": "post_post_google_login", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/FormLoginUser3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Do log in with google code", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Session" } } } } } } }, "\/api\/attachments\/{id}\/ocr\/retry": { "post": { "tags": [ "Attachment \/ Attachment" ], "summary": "Runs the OCR of an attachment again in the background, whatever its current OCR status.", "description": "Only for super admins.", "operationId": "post_post_attachment_ocr_retry", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the attachment with the OCR queued", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Attachment" } } } } } } }, "\/api\/base\/accesstag": { "get": { "tags": [ "Access \/ AccessTag" ], "summary": "Returns a list of all AccessTag", "operationId": "get_base_access_tag_cget", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: LOGGED_IN | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all AccessTag", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessTag" } } } } } } }, "post": { "tags": [ "Access \/ AccessTag" ], "summary": "Creates a new AccessTag entry.", "operationId": "post_base_access_tag_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AccessTag2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add new AccessTag", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AccessTag" } } } } } } }, "\/api\/base\/accesstag\/{id}": { "get": { "tags": [ "Access \/ AccessTag" ], "summary": "Returns a single AccessTag entry.", "operationId": "get_base_access_tag_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single AccessTag", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AccessTag" } } } } } }, "put": { "tags": [ "Access \/ AccessTag" ], "summary": "Updates an existing AccessTag entry.", "operationId": "put_base_access_tag_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AccessTag2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single AccessTag", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AccessTag" } } } } } }, "patch": { "tags": [ "Access \/ AccessTag" ], "summary": "Updates an existing AccessTag entry.", "operationId": "patch_base_access_tag_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AccessTag2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single AccessTag", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AccessTag" } } } } } } }, "\/api\/base\/base_change_update_multi\/{className}": { "post": { "tags": [ "Tool \/ SimpleChange" ], "summary": "Updates an existing field in multiple items entry.", "operationId": "post_base_change_update_multi", "parameters": [ { "name": "suppressNotification", "in": "query", "description": "If true and the change marks bookings\/events as deleted, no automatic cancellation notification is sent for the affected items (temporary, per-action).", "required": false, "schema": { "type": "boolean" } }, { "name": "className", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/base\/api_token\/create_mqtt_jwt": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Creates a new MqttToken as a super admin", "operationId": "get_api_token_create_mqtt_jwt_action", "parameters": [ { "name": "allowedPath", "in": "query", "description": "allowed path", "required": true, "schema": { "type": "string" } }, { "name": "validSeconds", "in": "query", "description": "number of seconds in the future. 31536000", "required": false, "schema": { "type": "number" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Creates a new MqttToken as a super admin", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Session" } } } } } } }, "\/api\/base\/api_token\/create_jwt": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Creates a new JWT Login Token", "operationId": "get_api_token_create_jwt_action", "parameters": [ { "name": "scopes", "in": "query", "description": "comma seperated list of scopes", "required": false, "schema": { "type": "string" } }, { "name": "allowedPath", "in": "query", "description": "allowed path", "required": false, "schema": { "type": "string" } }, { "name": "allowedMethod", "in": "query", "description": "allowed path", "required": false, "schema": { "type": "string" } }, { "name": "validSeconds", "in": "query", "description": "number of seconds in the future. 86400", "required": false, "schema": { "type": "number" } }, { "name": "maxUserAccessType", "in": "query", "description": "max user access type to add to jwt. 2 = write, 1 = edit, 0 = read", "required": false, "schema": { "type": "number" } }, { "name": "extraShort", "in": "query", "description": "replace the algorithm part of the jwt with the default value to save 32 chars. true \/ false", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Creates a new JWT Login Token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Session" } } } } } } }, "\/api\/base\/api_access_token\/{id}": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Returns a single ApiAccessToken entry.", "operationId": "get_api_access_token_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ApiAccessToken", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ApiAccessToken" } } } } } }, "delete": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Deletes a single ApiAccessToken entry.", "operationId": "delete_api_access_token_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete single ApiAccessToken", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ApiAccessToken" } } } } } } }, "\/api\/base\/api_access_token": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Returns a list of own ApiAccessToken", "operationId": "get_api_access_token_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of own ApiAccessToken", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ApiAccessToken" } } } } } } } }, "\/api\/base\/api_access_token_test": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Test if the api access token is valid. Use mode=info to get token details, user info, and available scopes.", "operationId": "get_api_access_token_test", "parameters": [ { "name": "mode", "in": "query", "description": "Set to 'info' to return token details, user info, and available scopes", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns true if the api access token is valid", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/base\/2fa\/new\/{type}": { "get": { "tags": [ "User \/ User2Factor" ], "summary": "This method will create a new User2Factor Object for given type", "operationId": "get_user_2fa_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "This method will create a new User2Factor Object for given type", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User2Factor" } } } } } } }, "\/api\/base\/2fa\/verify\/{id}\/{code}": { "get": { "tags": [ "User \/ User2Factor" ], "summary": "This method will verify a User2Factor Object", "operationId": "get_user_2fa_verify", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "This method will verify a User2Factor Object", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User2Factor2" } } } } } } }, "\/api\/base\/2fa\/delete\/{id}\/{code}": { "delete": { "tags": [ "User \/ User2Factor" ], "summary": "This method will delete a User2Factor Object, requires a valid 2fa code", "operationId": "delete_user_2fa_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "This method will delete a User2Factor Object, requires a valid 2fa code", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User2Factor2" } } } } } } }, "\/api\/base\/2fa\/list": { "get": { "tags": [ "User \/ User2Factor" ], "summary": "This method will get all available User2Factor Objects", "operationId": "get_user_2fa_get_all", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "This method will get all available User2Factor Objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User2Factor2" } } } } } } } }, "\/api\/cp\/signup\/start": { "get": { "tags": [ "Login \/ Self Sign Up" ], "summary": "Starts a new self sign up process. Returns a token and required fields.", "operationId": "get_cp_self_sign_up_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Starts a new self sign up process. Returns a token and required fields.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfSignUpLog" } } } } } } }, "\/api\/cp\/signup\/finish\/{token}": { "post": { "tags": [ "Login \/ Self Sign Up" ], "summary": "Finish self sign up process. Requires token from Self Sign Up - Start.", "operationId": "post_cp_self_sign_up_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfSignUpLog2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Finish self sign up process. Requires token from Self Sign Up - Start.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfSignUpLog" } } } } } } }, "\/api\/cp\/signup\/unified_start\/{mode}": { "get": { "tags": [ "Customer \/ BaseDataSelfService" ], "summary": "Returns a self signup token + possible membership items", "operationId": "get_cp_self_sign_up_get_unified", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "mode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a self signup token + possible membership items", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SimpleDynamicResponse" } } } } } } }, "\/api\/cp\/signup\/code": { "get": { "tags": [ "Customer \/ Self Sign Up Code" ], "summary": "Returns a list of all SelfSignUpLogInviteCode", "operationId": "get_cp_self_sign_up_invite_code_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "product", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "unifiedCategory", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "logBookEntryContentType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "externalDescription", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "internalDescription", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all SelfSignUpLogInviteCode", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfSignUpLogInviteCode" } } } } } } }, "post": { "tags": [ "Customer \/ Self Sign Up Code" ], "summary": "Add a new SelfSignUpLogInviteCode", "operationId": "post_cp_self_sign_up_invite_code_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfSignUpLogInviteCode" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new SelfSignUpLogInviteCode", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfSignUpLogInviteCode" } } } } } } }, "\/api\/cp\/signup\/code\/{identifier}": { "get": { "tags": [ "Customer \/ Self Sign Up Code" ], "summary": "Returns a single SelfSignUpLogInviteCode entry.", "operationId": "get_cp_self_sign_up_invite_code_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single SelfSignUpLogInviteCode", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfSignUpLogInviteCode" } } } } } }, "put": { "tags": [ "Customer \/ Self Sign Up Code" ], "summary": "Updates an existing SelfSignUpLogInviteCode entry.", "operationId": "put_cp_self_sign_up_invite_code_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfSignUpLogInviteCode" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single SelfSignUpLogInviteCode", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfSignUpLogInviteCode" } } } } } }, "patch": { "tags": [ "Customer \/ Self Sign Up Code" ], "summary": "Updates an existing SelfSignUpLogInviteCode entry.", "operationId": "patch_cp_self_sign_up_invite_code_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfSignUpLogInviteCode" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single SelfSignUpLogInviteCode", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfSignUpLogInviteCode" } } } } } } }, "\/api\/cp\/self_service\/unified_profile\/{mode}": { "get": { "tags": [ "Customer \/ BaseDataSelfService" ], "summary": "Returns the full profile of the current user with billing account, tickets, bookings", "operationId": "get_cp_base_data_self_service_get_unified_profile", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "mode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the full profile of the current user with billing account, tickets, bookings", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SimpleDynamicResponse" } } } } } } }, "\/api\/cp\/self_service\/attachments": { "get": { "tags": [ "Customer \/ BaseDataSelfService" ], "summary": "This method will get all Attachment Objects attached to one of the CRMPersons the current customer has access to.", "operationId": "get_cp_base_data_self_service_cget_attachments", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "personId", "in": "query", "description": "If set, only attachments for this CRMPerson are returned (must be in the list of allowed persons).", "required": false, "schema": { "type": "integer" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/cp\/self_service\/person\/{personIdentifier}\/membership_pause": { "get": { "tags": [ "CustomerPanel \/ Self-Service \/ MembershipPause" ], "summary": "Rules, the memberships of the person that can be paused and the pauses handed in so far", "operationId": "get_cp_membership_pause_overview", "parameters": [ { "name": "personIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Rules, memberships and requests", "content": { "application\/json": { "schema": { "properties": { "rules": { "type": "object" }, "earliest_start": { "type": "string", "format": "date-time" }, "latest_start": { "type": "string", "format": "date-time", "nullable": true }, "memberships": { "type": "array", "items": { "type": "object" } }, "requests": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } } } }, "post": { "tags": [ "CustomerPanel \/ Self-Service \/ MembershipPause" ], "summary": "Hand in a pause for a membership of the person (applied at once when the club does not approve)", "operationId": "post_cp_membership_pause_post", "parameters": [ { "name": "personIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "log_book_entry": { "type": "integer" }, "start": { "type": "string", "format": "date" }, "end": { "type": "string", "format": "date" }, "reason": { "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The new request" } } } }, "\/api\/cp\/self_service\/membership_pause\/{id}\/withdraw": { "put": { "tags": [ "CustomerPanel \/ Self-Service \/ MembershipPause" ], "summary": "Withdraw an own pause: open ones always, approved ones until the withdraw deadline", "operationId": "put_cp_membership_pause_withdraw", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The withdrawn request" } } }, "patch": { "tags": [ "CustomerPanel \/ Self-Service \/ MembershipPause" ], "summary": "Withdraw an own pause: open ones always, approved ones until the withdraw deadline", "operationId": "patch_cp_membership_pause_withdraw", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The withdrawn request" } } } }, "\/api\/cp\/self_service\/donations": { "get": { "tags": [ "CustomerPanel \/ Self-Service \/ Donations" ], "summary": "Own donations, recurring donations and the years with a Sammelbest\u00e4tigung", "operationId": "get_cp_donation_self_service_overview", "responses": { "200": { "description": "Donations of the logged-in donor", "content": { "application\/json": { "schema": { "properties": { "donations": { "type": "array", "items": { "type": "object" } }, "recurring_donations": { "type": "array", "items": { "type": "object" } }, "collective_receipt_years": { "type": "array", "items": { "type": "object" } }, "receipts_available": { "type": "boolean" }, "recurring_options": { "type": "object" } }, "type": "object" } } } } } } }, "\/api\/cp\/self_service\/donations\/{id}\/pdf": { "get": { "tags": [ "CustomerPanel \/ Self-Service \/ Donations" ], "summary": "Zuwendungsbest\u00e4tigung of an own donation as PDF", "operationId": "get_cp_donation_self_service_pdf", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The receipt as PDF" } } } }, "\/api\/cp\/self_service\/donations\/collective_receipt\/{year}\/pdf": { "get": { "tags": [ "CustomerPanel \/ Self-Service \/ Donations" ], "summary": "Sammelbest\u00e4tigung of the logged-in person for a year as PDF", "operationId": "get_cp_donation_self_service_collective_pdf", "parameters": [ { "name": "year", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The Sammelbest\u00e4tigung as PDF" } } } }, "\/api\/cp\/self_service\/recurring_donations\/{id}": { "put": { "tags": [ "CustomerPanel \/ Self-Service \/ Donations" ], "summary": "Change amount, interval or bank account of an own recurring donation", "description": "A new bank account needs a new SEPA mandate: the donor agrees again, the mandate gets a new\nreference and the next collection is a first collection.", "operationId": "put_cp_donation_self_service_recurring_patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "amount": { "type": "number" }, "interval": { "description": "monthly, quarterly, half_yearly or yearly", "type": "string" }, "accountHolder": { "type": "string" }, "iban": { "type": "string" }, "bic": { "type": "string" }, "mandateConsent": { "description": "required with a new IBAN", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The changed recurring donation" } } }, "patch": { "tags": [ "CustomerPanel \/ Self-Service \/ Donations" ], "summary": "Change amount, interval or bank account of an own recurring donation", "description": "A new bank account needs a new SEPA mandate: the donor agrees again, the mandate gets a new\nreference and the next collection is a first collection.", "operationId": "patch_cp_donation_self_service_recurring_patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "amount": { "type": "number" }, "interval": { "description": "monthly, quarterly, half_yearly or yearly", "type": "string" }, "accountHolder": { "type": "string" }, "iban": { "type": "string" }, "bic": { "type": "string" }, "mandateConsent": { "description": "required with a new IBAN", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The changed recurring donation" } } } }, "\/api\/cp\/self_service\/recurring_donations\/{id}\/pause": { "post": { "tags": [ "CustomerPanel \/ Self-Service \/ Donations" ], "summary": "Pause an own recurring donation; collections not yet handed to the bank are stopped", "operationId": "post_cp_donation_self_service_recurring_pause", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The paused recurring donation" } } } }, "\/api\/cp\/self_service\/recurring_donations\/{id}\/resume": { "post": { "tags": [ "CustomerPanel \/ Self-Service \/ Donations" ], "summary": "Resume an own paused recurring donation; the next collection is never in the past", "operationId": "post_cp_donation_self_service_recurring_resume", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The running recurring donation" } } } }, "\/api\/cp\/self_service\/recurring_donations\/{id}\/cancel": { "post": { "tags": [ "CustomerPanel \/ Self-Service \/ Donations" ], "summary": "Cancel an own recurring donation", "operationId": "post_cp_donation_self_service_recurring_cancel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The canceled recurring donation" } } } }, "\/api\/cp\/self_service_membership\/public": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a public list of all SelfServiceMembershipStep", "operationId": "get_cp_self_service_membership_step_public", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "order", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a public list of all SelfServiceMembershipStep", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfServiceMembershipStep" } } } } } } } }, "\/api\/cp\/self_service_membership\/step": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a list of all SelfServiceMembershipStep", "operationId": "get_cp_self_service_membership_step_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "order", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all SelfServiceMembershipStep", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfServiceMembershipStep2" } } } } } } }, "post": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Add a new SelfServiceMembershipStep", "operationId": "post_cp_self_service_membership_step_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceMembershipStep2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new SelfServiceMembershipStep", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipStep2" } } } } } } }, "\/api\/cp\/self_service_membership\/step\/{identifier}": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a single SelfServiceMembershipStep entry.", "operationId": "get_cp_self_service_membership_step_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single SelfServiceMembershipStep", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipStep2" } } } } } }, "put": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Updates an existing SelfServiceMembershipStep entry.", "operationId": "put_cp_self_service_membership_step_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceMembershipStep2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single SelfServiceMembershipStep", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipStep2" } } } } } }, "patch": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Updates an existing SelfServiceMembershipStep entry.", "operationId": "patch_cp_self_service_membership_step_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceMembershipStep2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single SelfServiceMembershipStep", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipStep2" } } } } } } }, "\/api\/cp\/self_service_membership\/category": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a list of all SelfServiceMembershipCategory", "operationId": "get_cp_self_service_membership_category_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "order", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "unifiedCategory", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "membershipStep", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "minAge", "in": "query", "description": "The lowest age (in years) a person may have to use this entry - null means no lower limit | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxAge", "in": "query", "description": "The highest age (in years) a person may have to use this entry - null means no upper limit | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all SelfServiceMembershipCategory", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfServiceMembershipCategory" } } } } } } }, "post": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Add a new SelfServiceMembershipCategory", "operationId": "post_cp_self_service_membership_category_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceMembershipCategory" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new SelfServiceMembershipCategory", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipCategory" } } } } } } }, "\/api\/cp\/self_service_membership\/category\/{identifier}": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a single SelfServiceMembershipCategory entry.", "operationId": "get_cp_self_service_membership_category_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single SelfServiceMembershipCategory", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipCategory" } } } } } }, "put": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Updates an existing SelfServiceMembershipCategory entry.", "operationId": "put_cp_self_service_membership_category_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceMembershipCategory" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single SelfServiceMembershipCategory", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipCategory" } } } } } }, "patch": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Updates an existing SelfServiceMembershipCategory entry.", "operationId": "patch_cp_self_service_membership_category_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceMembershipCategory" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single SelfServiceMembershipCategory", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipCategory" } } } } } } }, "\/api\/cp\/membership_fee_rule_set": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a list of all MembershipFeeRuleSet", "operationId": "get_cp_membership_fee_rule_set_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Only active rule sets are used | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "validFrom", "in": "query", "description": "The rule set applies from this date on (null: always) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "adultAge", "in": "query", "description": "From this age on a person counts as adult (role \"adult\"), younger as child | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all MembershipFeeRuleSet", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MembershipFeeRuleSet" } } } } } } }, "post": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Add a new MembershipFeeRuleSet", "operationId": "post_cp_membership_fee_rule_set_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MembershipFeeRuleSet" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MembershipFeeRuleSet", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MembershipFeeRuleSet" } } } } } } }, "\/api\/cp\/membership_fee_rule_set\/validate": { "post": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Check rules without saving: errors, warnings and the rules with normalized references", "operationId": "post_cp_membership_fee_rule_set_validate", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "rules": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Check result", "content": { "application\/json": { "schema": { "properties": { "rules": { "type": "array", "items": { "type": "object" } }, "errors": { "type": "array", "items": { "type": "string" } }, "warnings": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } } } } }, "\/api\/cp\/membership_fee_rule_set\/{identifier}": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a single MembershipFeeRuleSet entry.", "operationId": "get_cp_membership_fee_rule_set_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single MembershipFeeRuleSet", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MembershipFeeRuleSet" } } } } } }, "put": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Updates an existing MembershipFeeRuleSet entry.", "operationId": "put_cp_membership_fee_rule_set_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MembershipFeeRuleSet" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single MembershipFeeRuleSet", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MembershipFeeRuleSet" } } } } } }, "patch": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Updates an existing MembershipFeeRuleSet entry.", "operationId": "patch_cp_membership_fee_rule_set_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MembershipFeeRuleSet" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single MembershipFeeRuleSet", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MembershipFeeRuleSet" } } } } } } }, "\/api\/cp\/membership_fee_rule_set\/{identifier}\/evaluate": { "post": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Calculate the fees of a sample household with a rule set: per person and base membership \/ selected\nitem the matching rule, product, class and amount", "operationId": "post_cp_membership_fee_rule_set_evaluate", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "date": { "description": "Y-m-d, default today", "type": "string" }, "persons": { "description": "In household order: the first adult is the main member", "type": "array", "items": { "properties": { "label": { "type": "string" }, "birthday": { "type": "string" }, "age": { "type": "integer" }, "discountReason": { "type": "integer" }, "items": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Fees per person", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/cp\/self_service_membership\/discount_reason": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a list of all SelfServiceDiscountReason", "operationId": "get_cp_self_service_discount_reason_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "order", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "minAge", "in": "query", "description": "The lowest age (in years) a person may have to use this entry - null means no lower limit | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxAge", "in": "query", "description": "The highest age (in years) a person may have to use this entry - null means no upper limit | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requireAttachment", "in": "query", "description": "The application needs a proof (upload) for this reason | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all SelfServiceDiscountReason", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfServiceDiscountReason" } } } } } } }, "post": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Add a new SelfServiceDiscountReason", "operationId": "post_cp_self_service_discount_reason_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceDiscountReason" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new SelfServiceDiscountReason", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceDiscountReason" } } } } } } }, "\/api\/cp\/self_service_membership\/discount_reason\/{identifier}": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a single SelfServiceDiscountReason entry.", "operationId": "get_cp_self_service_discount_reason_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single SelfServiceDiscountReason", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceDiscountReason" } } } } } }, "put": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Updates an existing SelfServiceDiscountReason entry.", "operationId": "put_cp_self_service_discount_reason_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceDiscountReason" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single SelfServiceDiscountReason", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceDiscountReason" } } } } } }, "patch": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Updates an existing SelfServiceDiscountReason entry.", "operationId": "patch_cp_self_service_discount_reason_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceDiscountReason" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single SelfServiceDiscountReason", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceDiscountReason" } } } } } } }, "\/api\/cp\/self_service_membership\/application_config": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Rules of the membership application", "operationId": "get_cp_self_service_membership_application_config", "responses": { "200": { "description": "Rules of the membership application", "content": { "application\/json": { "schema": { "properties": { "entry_date_enabled": { "description": "Desired entry date offered (club mode)", "type": "boolean" }, "entry_date_first_of_month": { "type": "boolean" }, "entry_date_max_months_ahead": { "description": "0 = unlimited", "type": "integer" }, "entry_date_earliest": { "type": "string", "format": "date", "nullable": true }, "entry_date_latest": { "type": "string", "format": "date", "nullable": true }, "proofs_enabled": { "type": "boolean" }, "discount_reasons_enabled": { "type": "boolean" }, "item_coverage_enabled": { "type": "boolean" }, "discount_reasons": { "type": "array", "items": { "type": "object" } }, "fee_rules_enabled": { "description": "The fee rules decide the membership class", "type": "boolean" }, "fee_rules_class_step_id": { "description": "Wizard step of the classes, hidden in the app", "type": "integer", "nullable": true }, "fee_rules_price_preview": { "description": "Show the expected fee (price_preview)", "type": "boolean" }, "fee_rules_preview_hint": { "type": "string", "nullable": true } }, "type": "object" } } } } } } }, "\/api\/cp\/self_service_membership\/price_preview": { "post": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Membership class and expected fee of an application in progress, from the fee rule set that applies at\nthe desired entry date (setting iw_self_service_membership_fee_rules_enabled). The household of the\nselected account joins the evaluation (setting iw_self_service_membership_fee_rules_household).", "operationId": "post_cp_self_service_membership_price_preview", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "personId": { "description": "Existing person of the account the application is for", "type": "integer" }, "birthday": { "description": "Birthday of a new person", "type": "string", "format": "date" }, "discountReasonId": { "type": "integer" }, "items": { "description": "Selected wizard items", "type": "array", "items": { "type": "integer" } }, "desiredEntryDate": { "type": "string", "format": "date" } }, "type": "object" } } } }, "responses": { "200": { "description": "Class and fee", "content": { "application\/json": { "schema": { "properties": { "available": { "description": "false: no rule set applies (message)", "type": "boolean" }, "class": { "type": "string", "nullable": true }, "class_item": { "type": "object", "nullable": true }, "lines": { "type": "array", "items": { "type": "object" } }, "total_monthly": { "type": "number" }, "total_once": { "type": "number" } }, "type": "object" } } } } } } }, "\/api\/cp\/self_service_membership\/item": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a list of all SelfServiceMembershipItem", "operationId": "get_cp_self_service_membership_item_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "order", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "unifiedCategory", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "minAge", "in": "query", "description": "The lowest age (in years) a person may have to use this entry - null means no lower limit | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxAge", "in": "query", "description": "The highest age (in years) a person may have to use this entry - null means no upper limit | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all SelfServiceMembershipItem", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem" } } } } } } }, "post": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Add a new SelfServiceMembershipItem", "operationId": "post_cp_self_service_membership_item_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new SelfServiceMembershipItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem" } } } } } } }, "\/api\/cp\/self_service_membership\/item\/{identifier}": { "get": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Returns a single SelfServiceMembershipItem entry.", "operationId": "get_cp_self_service_membership_item_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single SelfServiceMembershipItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem" } } } } } }, "put": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Updates an existing SelfServiceMembershipItem entry.", "operationId": "put_cp_self_service_membership_item_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single SelfServiceMembershipItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem" } } } } } }, "patch": { "tags": [ "Customer \/ SelfServiceMembership" ], "summary": "Updates an existing SelfServiceMembershipItem entry.", "operationId": "patch_cp_self_service_membership_item_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single SelfServiceMembershipItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem" } } } } } } }, "\/api\/cp\/public_session": { "get": { "tags": [ "Public \/ Session" ], "summary": "Get or start a new public session", "operationId": "get_cp_public_session_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get or start a new public session", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PublicSession" } } } } } }, "put": { "tags": [ "Public \/ Session" ], "summary": "Update \/ create fields of public session", "operationId": "put_cp_public_session_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PublicSession2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update fields of public session", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PublicSession3" } } } } } }, "post": { "tags": [ "Public \/ Session" ], "summary": "Update \/ create fields of public session", "operationId": "post_cp_public_session_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PublicSession2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update fields of public session", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PublicSession3" } } } } } }, "patch": { "tags": [ "Public \/ Session" ], "summary": "Update \/ create fields of public session", "operationId": "patch_cp_public_session_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PublicSession2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update fields of public session", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PublicSession3" } } } } } } }, "\/api\/public\/chat\/support": { "get": { "tags": [ "Public \/ SupportChat" ], "summary": "Get existing support chat", "operationId": "get_public_chatroom_support_get", "parameters": [ { "name": "x-public-session-token", "in": "header", "description": "Public session token identifying the visitor (may alternatively be passed as the 'x-public-session-token' \/ 'ps_token' query parameter or, on secure connections, the 'X-PUBLIC-SESSION-TOKEN' cookie)", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "Public \/ SupportChat" ], "summary": "Start or get existing support chat", "operationId": "post_public_chatroom_support_post", "parameters": [ { "name": "x-public-session-token", "in": "header", "description": "Public session token identifying the visitor (may alternatively be passed as the 'x-public-session-token' \/ 'ps_token' query parameter or, on secure connections, the 'X-PUBLIC-SESSION-TOKEN' cookie)", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "message": { "description": "First message text", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Support chatroom created or retrieved", "content": { "application\/json": { "schema": { "properties": { "chatroom": { "type": "object" }, "participant": { "type": "object" }, "message": { "type": "object" }, "office_hours": { "description": "enabled, open, text (chatroom_support_office_hours_enabled)", "type": "object" } }, "type": "object" } } } } } } }, "\/api\/public\/chat\/message": { "get": { "tags": [ "Public \/ SupportChat" ], "summary": "Get messages for support chat", "operationId": "get_public_chatroom_message_cget", "parameters": [ { "name": "x-public-session-token", "in": "header", "description": "Public session token identifying the visitor (may alternatively be passed as the 'x-public-session-token' \/ 'ps_token' query parameter or, on secure connections, the 'X-PUBLIC-SESSION-TOKEN' cookie)", "required": true, "schema": { "type": "string" } }, { "name": "chatroom", "in": "query", "description": "Chatroom notification token", "required": true, "schema": { "type": "string" } }, { "name": "afterId", "in": "query", "description": "Load messages after this ID", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "Public \/ SupportChat" ], "summary": "Send a message in existing support chat", "operationId": "post_public_chatroom_message_post", "parameters": [ { "name": "x-public-session-token", "in": "header", "description": "Public session token identifying the visitor (may alternatively be passed as the 'x-public-session-token' \/ 'ps_token' query parameter or, on secure connections, the 'X-PUBLIC-SESSION-TOKEN' cookie)", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "chatroom": { "description": "Chatroom notification token", "type": "string" }, "message": { "description": "Message text", "type": "string" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/cp\/chat\/trainer\/event\/{eventIdentifier}": { "get": { "tags": [ "Chat \/ TrainerChatroom" ], "summary": "Return the chatroom of an event as its trainer", "operationId": "get_trainer_event_chatroom_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Chatroom of the event", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom" } } } } } }, "post": { "tags": [ "Chat \/ TrainerChatroom" ], "summary": "Create (or return) the chatroom of an event as its trainer", "description": "Requires trainerCanCreateChatroom on the event data type, and the\nlogged in person has to be the performing person of the event.", "operationId": "post_trainer_event_chatroom_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Chatroom of the event", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom" } } } } } } }, "\/api\/cp\/chat\/trainer\/participant\/{identifier}": { "put": { "tags": [ "Chat \/ TrainerChatroom" ], "summary": "Grant or revoke write access for a participant of a chatroom you moderate", "description": "Only room admins (the event trainers) and backend chat admins may call\nthis. Room admins themselves keep their write access - a trainer cannot\nsilence a co-trainer.", "operationId": "put_trainer_chatroom_participant_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomParticipant" } }, "type": "object" } } } }, "responses": { "200": { "description": "The updated participant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomParticipant" } } } } } }, "delete": { "tags": [ "Chat \/ TrainerChatroom" ], "summary": "Remove a participant from a chatroom you moderate", "description": "Co-trainers (room admins) cannot be removed. The event sync does not add\nthe person again. Requires chatroom_room_admin_manage_members_enabled.", "operationId": "delete_trainer_chatroom_participant_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Removed" } } }, "patch": { "tags": [ "Chat \/ TrainerChatroom" ], "summary": "Grant or revoke write access for a participant of a chatroom you moderate", "description": "Only room admins (the event trainers) and backend chat admins may call\nthis. Room admins themselves keep their write access - a trainer cannot\nsilence a co-trainer.", "operationId": "patch_trainer_chatroom_participant_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomParticipant" } }, "type": "object" } } } }, "responses": { "200": { "description": "The updated participant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomParticipant" } } } } } } }, "\/api\/cp\/chat\/trainer\/chatroom\/{identifier}\/candidates": { "get": { "tags": [ "Chat \/ TrainerChatroom" ], "summary": "Persons a room admin can (re-)add to the chatroom", "description": "Former participants and, for an event chat, persons signed up for the\nevent who are not in the room. Requires chatroom_room_admin_manage_members_enabled.", "operationId": "get_trainer_chatroom_candidates_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of candidates", "content": { "application\/json": { "schema": { "type": "array", "items": { "properties": { "person_id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "reason": { "description": "former | signed_up", "type": "string" } }, "type": "object" } } } } } } } }, "\/api\/cp\/chat\/trainer\/chatroom\/{identifier}\/participant": { "post": { "tags": [ "Chat \/ TrainerChatroom" ], "summary": "Add a person to a chatroom you moderate", "description": "Only former participants and persons signed up for the event of the\nchatroom (see candidates). Requires chatroom_room_admin_manage_members_enabled.", "operationId": "post_trainer_chatroom_participant_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "person_id": { "type": "integer", "example": 12 } }, "type": "object" } } } }, "responses": { "200": { "description": "The added participant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomParticipant" } } } } } } }, "\/api\/cp\/chat\/trainer\/chatroom\/{identifier}": { "put": { "tags": [ "Chat \/ TrainerChatroom" ], "summary": "Rename a chatroom you moderate", "description": "Requires chatroom_room_admin_manage_members_enabled.", "operationId": "put_trainer_chatroom_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "name": { "type": "string", "example": "U12 Training" } }, "type": "object" } } } }, "responses": { "200": { "description": "The renamed chatroom", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom" } } } } } }, "patch": { "tags": [ "Chat \/ TrainerChatroom" ], "summary": "Rename a chatroom you moderate", "description": "Requires chatroom_room_admin_manage_members_enabled.", "operationId": "patch_trainer_chatroom_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "name": { "type": "string", "example": "U12 Training" } }, "type": "object" } } } }, "responses": { "200": { "description": "The renamed chatroom", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom" } } } } } } }, "\/api\/cp\/chatbot\/consent": { "get": { "tags": [ "Chat \/ CustomerChatbotConsent" ], "summary": "Aktueller Opt-in-Stand der eingeloggten Person samt Einwilligungstext", "operationId": "get_customer_chatbot_consent_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Opt-in-Stand und aktueller Einwilligungstext", "content": { "application\/json": { "schema": { "properties": { "opt_in": { "type": "boolean" }, "opt_in_at": { "type": "string", "nullable": true }, "text_version": { "type": "string", "nullable": true }, "current_text": { "type": "string" }, "current_version": { "type": "string" }, "requires_renewal": { "type": "boolean" } }, "type": "object" } } } } } }, "put": { "tags": [ "Chat \/ CustomerChatbotConsent" ], "summary": "Opt-in erteilen oder widerrufen", "operationId": "put_customer_chatbot_consent_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "granted": { "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Der neue Opt-in-Stand, gleiches Format wie GET" } } }, "patch": { "tags": [ "Chat \/ CustomerChatbotConsent" ], "summary": "Opt-in erteilen oder widerrufen", "operationId": "patch_customer_chatbot_consent_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "granted": { "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Der neue Opt-in-Stand, gleiches Format wie GET" } } } }, "\/api\/cp\/app_usage\/events": { "post": { "tags": [ "CustomerPanel \/ CustomerAppUsage" ], "summary": "Aufrufe von Ansichten der Mitglieder-App zaehlen (anonym)", "description": "Die Antwort ist immer 204, auch wenn die Statistik aus ist oder der Batch\nverworfen wurde - die App soll daraus nichts ableiten muessen. Eine\nmitgeschickte Sitzung wird nicht gelesen.", "operationId": "post_customer_app_usage_events_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "session": { "description": "Zufaellige UUID v4, nur im Speicher der App", "type": "string", "example": "3f2c1a9e-5b7d-4c1e-9a2b-1c3d5e7f9a0b" }, "platform": { "type": "string", "example": "web" }, "app_version": { "type": "string", "example": "26.10.1" }, "logged_in": { "type": "boolean", "example": false }, "views": { "type": "array", "items": { "type": "string" }, "example": [ "HomeOverviewViewRoute", "EventsViewRoute" ] } }, "type": "object" } } } }, "responses": { "204": { "description": "Angenommen" } } } }, "\/api\/cp\/app_usage\/opt_out": { "put": { "tags": [ "CustomerPanel \/ CustomerAppUsage" ], "summary": "Widerspruch der eingeloggten Person gegen die anonyme Nutzungsstatistik setzen oder aufheben", "description": "Gilt auf allen Geraeten der Person: die App liest ihn aus den StaticData\n(`app_usage_opt_out`) und schickt dann nichts mehr.", "operationId": "put_customer_app_usage_opt_out_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "opt_out": { "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Der neue Stand", "content": { "application\/json": { "schema": { "properties": { "opt_out": { "type": "boolean" } }, "type": "object" } } } } } }, "patch": { "tags": [ "CustomerPanel \/ CustomerAppUsage" ], "summary": "Widerspruch der eingeloggten Person gegen die anonyme Nutzungsstatistik setzen oder aufheben", "description": "Gilt auf allen Geraeten der Person: die App liest ihn aus den StaticData\n(`app_usage_opt_out`) und schickt dann nichts mehr.", "operationId": "patch_customer_app_usage_opt_out_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "opt_out": { "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Der neue Stand", "content": { "application\/json": { "schema": { "properties": { "opt_out": { "type": "boolean" } }, "type": "object" } } } } } } }, "\/api\/cp\/chatbot\/assistant": { "get": { "tags": [ "Chat \/ CustomerChatbotAssistant" ], "summary": "Verfuegbarkeit des persoenlichen KI-Assistenten", "operationId": "get_customer_chatbot_assistant_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Ob der Assistent nutzbar ist, ob noch ein Opt-in fehlt und ob der Raum schon existiert", "content": { "application\/json": { "schema": { "properties": { "available": { "type": "boolean" }, "opt_in_required": { "type": "boolean" }, "chatroom_id": { "type": "integer", "nullable": true } }, "type": "object" } } } } } } }, "\/api\/cp\/chat\/chatroom": { "get": { "tags": [ "Chat \/ CustomerChatroom" ], "summary": "Returns a list of all Chatrooms", "operationId": "get_customer_chatroom_cget", "parameters": [ { "name": "name", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2", "required": false, "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE_LIST, C1", "required": false, "schema": { "type": "boolean" } }, { "name": "trustLevel", "in": "query", "description": "Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich vom ChatroomTrustLevelHelper. | Requires access right: SCOPE_LIST, C1", "required": false, "schema": { "type": "string" } }, { "name": "handoverAt", "in": "query", "description": "Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper. | Requires access right: SCOPE_LIST, C1", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Die Person, deren persoenlicher Assistenten-Raum das hier ist. Genau eine Person plus Bot - die Logik dazu folgt, das Feld steht schon. | Requires access right: SCOPE_LIST, C1", "required": false, "schema": { "type": "string" } }, { "name": "mediaQuestionnaireAnswer", "in": "query", "description": "Requires access right: SCOPE_LIST, C1", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: C1, C2", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all Chatrooms", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Chatroom2" } } } } } } } }, "\/api\/cp\/chat\/chatroom\/{identifier}": { "get": { "tags": [ "Chat \/ CustomerChatroom" ], "summary": "Returns a single Chatroom entry.", "operationId": "get_customer_chatroom_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single Chatroom", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom" } } } } } } }, "\/api\/cp\/chat\/chatroom\/{identifier}\/participant": { "delete": { "tags": [ "Chat \/ CustomerChatroom" ], "summary": "Leave a chatroom", "description": "Event and group rooms only, not support rooms; trainers stay in their\nevent chat. The event sync does not add the person again. Requires\nchatroom_member_leave_enabled.", "operationId": "delete_customer_chatroom_leave", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Left" } } } }, "\/api\/cp\/chat\/chatroom\/{identifier}\/notifications": { "get": { "tags": [ "Chat \/ CustomerChatroom" ], "summary": "Own notification level of a chatroom", "description": "Returns level (all | mentions | none), muted_until and the effective level\nright now. Requires chatroom_mute_enabled.", "operationId": "get_customer_chatroom_notifications_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Notification level" } } }, "put": { "tags": [ "Chat \/ CustomerChatroom" ], "summary": "Set the own notification level of a chatroom", "description": "Body: level (all | mentions | none) and optionally muted_hours (1-720) or\nmuted_until (ISO date) to mute the room completely for a while; neither\nclears the pause. Requires chatroom_mute_enabled (sonst 8618).", "operationId": "put_customer_chatroom_notifications_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "level": { "type": "string", "enum": [ "all", "mentions", "none" ] }, "muted_hours": { "type": "integer" }, "muted_until": { "type": "string", "format": "date-time" } }, "type": "object" } } } }, "responses": { "200": { "description": "Notification level" } } }, "patch": { "tags": [ "Chat \/ CustomerChatroom" ], "summary": "Set the own notification level of a chatroom", "description": "Body: level (all | mentions | none) and optionally muted_hours (1-720) or\nmuted_until (ISO date) to mute the room completely for a while; neither\nclears the pause. Requires chatroom_mute_enabled (sonst 8618).", "operationId": "patch_customer_chatroom_notifications_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "level": { "type": "string", "enum": [ "all", "mentions", "none" ] }, "muted_hours": { "type": "integer" }, "muted_until": { "type": "string", "format": "date-time" } }, "type": "object" } } } }, "responses": { "200": { "description": "Notification level" } } } }, "\/api\/cp\/chat\/chatroom\/{identifier}\/search": { "get": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Search the messages of a chatroom\nQuery: q (2 to 100 characters), limit (1-50, default 30). Visible messages whose text contains q,\nnewest first. Requires chatroom_search_enabled (sonst 8618).", "operationId": "get_customer_chatroom_search", "parameters": [ { "name": "chatroom", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "participant", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Messages of the chatroom containing the search term", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatroomMessage" } } } } } } } }, "\/api\/cp\/chat\/support_hours": { "get": { "tags": [ "Chat \/ CustomerChatroom" ], "summary": "Hinweis fuer den Support-Chat (chatroom_support_office_hours_enabled): waehrend der Buerozeiten\ndie uebliche Antwortzeit, sonst die Abwesenheitsnachricht. enabled = false, wenn ausgeschaltet.", "operationId": "get_customer_chat_support_hours", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "enabled, open, text", "content": { "application\/json": { "schema": { "properties": { "enabled": { "type": "boolean" }, "open": { "type": "boolean" }, "text": { "type": "string" } }, "type": "object" } } } } } } }, "\/api\/cp\/chat\/my_messages\/export": { "get": { "tags": [ "Chat \/ CustomerChatroom" ], "summary": "Alle eigenen Chatnachrichten als CSV-Datei (chatroom_message_export_enabled, sonst 8618): was die\nPerson in irgendeinem Raum geschrieben hat, auch geloeschte, solange sie gespeichert sind.", "operationId": "get_customer_chat_my_messages_export", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "CSV mit Datum, Chat, Nachricht, Anhaengen, Umfrage, Bearbeitet, Geloescht", "content": { "text\/csv": [] } } } } }, "\/api\/cp\/chat\/contacts": { "get": { "tags": [ "Chat \/ CustomerChatroomMember" ], "summary": "Persons the member may start a direct chat with", "description": "Shared current, upcoming or recent event (chatroom_member_direct_via_event, on by default) or shared\ndepartment (chatroom_member_direct_via_department), without blocked persons. Query q filters by name.\nRequires chatroom_member_direct_enabled (sonst 8618).", "operationId": "get_customer_chat_contacts", "parameters": [ { "name": "q", "in": "query", "description": "Part of the name", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of {person_id, name, reasons}" } } } }, "\/api\/cp\/chat\/direct": { "post": { "tags": [ "Chat \/ CustomerChatroomMember" ], "summary": "Get or start the direct chat with a person", "description": "Body: person (id). The same two persons always get the same room. Errors: 8618 off, 8621 no shared\nevent\/department, 8622 blocked, 8623 minor protection without parents on file. With minor protection a\nchat between an adult and a minor gets the minor's parents as readers.", "operationId": "post_customer_chatroom_direct_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "person": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "{id, token, name, member_started_type}" } } } }, "\/api\/cp\/chat\/group_candidates": { "get": { "tags": [ "Chat \/ CustomerChatroomMember" ], "summary": "Persons a trainer may put into a group", "description": "Signed-up (not waiting) and leading persons of the events the member leads (current, upcoming or recent).\nRequires chatroom_trainer_groups_enabled (sonst 8618); 8624 for members who lead no event.", "operationId": "get_customer_chat_group_candidates", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of {person_id, name, reasons}" } } } }, "\/api\/cp\/chat\/group": { "post": { "tags": [ "Chat \/ CustomerChatroomMember" ], "summary": "Start a group chat as trainer", "description": "Body: name (1-100 characters), persons (ids from group_candidates, 1-100). The trainer is room admin.\nErrors: 8618 off, 8624 not a trainer, 8621 a person is not in the trainer's events.", "operationId": "post_customer_chatroom_group_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "name": { "type": "string" }, "persons": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "{id, token, name, member_started_type}" } } } }, "\/api\/cp\/chat\/chatroom_message\/{identifier}\/report": { "post": { "tags": [ "Chat \/ CustomerChatroomMember" ], "summary": "Report a chat message", "description": "Body: reason (optional, up to 1000 characters). The office sees the report in its queue (Chat, Meldungen).\nWith chatroom_ai_moderation_enabled an unchecked message is checked by the AI moderation after the response.\nOnly participants of the room report, not their own messages; a second report of the same person on the\nsame message updates the open one. Requires chatroom_message_report_enabled (sonst 8618).", "operationId": "post_customer_chatroom_message_report_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "reason": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "{id, status}" } } } }, "\/api\/cp\/chat\/blocks": { "get": { "tags": [ "Chat \/ CustomerChatroomMember" ], "summary": "The persons the member blocked", "description": "Requires chatroom_block_enabled (sonst 8618).", "operationId": "get_customer_chat_blocks_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of {id, person_id, name, created}" } } }, "post": { "tags": [ "Chat \/ CustomerChatroomMember" ], "summary": "Block a person", "description": "Body: person (id). No more direct chats in either direction, and the person's messages are hidden for the\nmember in all rooms. Blocking twice keeps the first block. Requires chatroom_block_enabled (sonst 8618).", "operationId": "post_customer_chat_blocks_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "person": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "{id, person_id, name, created}" } } } }, "\/api\/cp\/chat\/blocks\/{identifier}": { "delete": { "tags": [ "Chat \/ CustomerChatroomMember" ], "summary": "Unblock a person", "operationId": "delete_customer_chat_blocks_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{removed: bool}" } } } }, "\/api\/cp\/chat\/chatroom_message\/{identifier}\/poll": { "get": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Result of the poll of a ChatroomMessage", "description": "Counts per answer, the own votes and, unless the poll is anonymous, who voted for what.\nRequires chatroom_polls_enabled (sonst 8618).", "operationId": "get_customer_chatroom_message_poll_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Poll result" } } }, "put": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Vote in the poll of a ChatroomMessage", "description": "Body: options (list of answer keys); replaces the own votes, an empty list takes the vote back.\nOnly one key unless the poll allows several answers. 8620 once the poll is closed.", "operationId": "put_customer_chatroom_message_poll_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "options": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Poll result" } } }, "patch": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Vote in the poll of a ChatroomMessage", "description": "Body: options (list of answer keys); replaces the own votes, an empty list takes the vote back.\nOnly one key unless the poll allows several answers. 8620 once the poll is closed.", "operationId": "patch_customer_chatroom_message_poll_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "options": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Poll result" } } } }, "\/api\/cp\/chat\/chatroom_message\/{identifier}\/poll\/close": { "put": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Close the poll of a ChatroomMessage", "description": "The creator, room admins and the administration end a poll; afterwards nobody can vote.", "operationId": "put_customer_chatroom_message_poll_close", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Poll result" } } }, "patch": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Close the poll of a ChatroomMessage", "description": "The creator, room admins and the administration end a poll; afterwards nobody can vote.", "operationId": "patch_customer_chatroom_message_poll_close", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Poll result" } } } }, "\/api\/cp\/chat\/chatroom_message": { "get": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Returns a list of all ChatroomMessages", "operationId": "get_customer_chatroom_message_cget", "parameters": [ { "name": "chatroom", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "participant", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all ChatroomMessages", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatroomMessage" } } } } } } } }, "\/api\/cp\/chat\/chatroom_message\/{identifier}": { "get": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Returns a single ChatroomMessage entry.", "operationId": "get_customer_chatroom_message_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ChatroomMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessage" } } } } } }, "put": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Updates an existing ChatroomMessage entry.", "operationId": "put_customer_chatroom_message_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessage" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatroomMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessage" } } } } } }, "patch": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Updates an existing ChatroomMessage entry.", "operationId": "patch_customer_chatroom_message_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessage" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatroomMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessage" } } } } } } }, "\/api\/cp\/chat\/chatroom_message\/{chatroomIdentifier}": { "post": { "tags": [ "Chat \/ CustomerChatroomMessage" ], "summary": "Add a new ChatroomMessage", "operationId": "post_customer_chatroom_message_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "chatroomIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessage" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ChatroomMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessage" } } } } } } }, "\/api\/cp\/chat\/chatroom_message_reaction\/{chatroomMessageIdentifier}": { "post": { "tags": [ "Chat \/ CustomerChatroomMessageReactionController" ], "summary": "Add a new ChatroomMessageReaction", "operationId": "post_customer_chatroom_message_reaction_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "chatroomMessageIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ChatroomMessageReaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction" } } } } } } }, "\/api\/cp\/chat\/chatroom_message_reaction\/{identifier}": { "put": { "tags": [ "Chat \/ CustomerChatroomMessageReactionController" ], "summary": "Updates an existing ChatroomMessageReaction entry.", "operationId": "put_customer_chatroom_message_reaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatroomMessageReaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction" } } } } } }, "patch": { "tags": [ "Chat \/ CustomerChatroomMessageReactionController" ], "summary": "Updates an existing ChatroomMessageReaction entry.", "operationId": "patch_customer_chatroom_message_reaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatroomMessageReaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction" } } } } } } }, "\/api\/chat\/chatroom": { "get": { "tags": [ "Chat \/ Chatroom" ], "summary": "Returns a list of all Chatrooms", "operationId": "get_chatroom_cget", "parameters": [ { "name": "name", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2", "required": false, "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE_LIST, C1", "required": false, "schema": { "type": "boolean" } }, { "name": "trustLevel", "in": "query", "description": "Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen; gesetzt wird sie ausschliesslich vom ChatroomTrustLevelHelper. | Requires access right: SCOPE_LIST, C1", "required": false, "schema": { "type": "string" } }, { "name": "handoverAt", "in": "query", "description": "Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das gesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das Team. Gesetzt und geloescht nur vom ChatbotHandoverHelper. | Requires access right: SCOPE_LIST, C1", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Die Person, deren persoenlicher Assistenten-Raum das hier ist. Genau eine Person plus Bot - die Logik dazu folgt, das Feld steht schon. | Requires access right: SCOPE_LIST, C1", "required": false, "schema": { "type": "string" } }, { "name": "mediaQuestionnaireAnswer", "in": "query", "description": "Requires access right: SCOPE_LIST, C1", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: C1, C2", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all Chatrooms", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Chatroom3" } } } } } } }, "post": { "tags": [ "Chat \/ Chatroom" ], "summary": "Add a new Chatroom", "operationId": "post_chatroom_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/Chatroom4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new Chatroom", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } } }, "\/api\/chat\/chatroom\/{identifier}": { "get": { "tags": [ "Chat \/ Chatroom" ], "summary": "Returns a single Chatroom entry.", "operationId": "get_chatroom_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single Chatroom", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } }, "put": { "tags": [ "Chat \/ Chatroom" ], "summary": "Updates an existing Chatroom entry.", "operationId": "put_chatroom_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/Chatroom4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single Chatroom", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } }, "delete": { "tags": [ "Chat \/ Chatroom" ], "summary": "Delete a single Chatroom", "operationId": "delete_chatroom_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single Chatroom", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } }, "patch": { "tags": [ "Chat \/ Chatroom" ], "summary": "Updates an existing Chatroom entry.", "operationId": "patch_chatroom_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/Chatroom4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single Chatroom", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } } }, "\/api\/chat\/chatroom\/assistant": { "post": { "tags": [ "Chat \/ Chatroom" ], "summary": "Liefert den persoenlichen Assistenten-Raum der eingeloggten Person und\nlegt ihn beim ersten Aufruf an.", "description": "Read genuegt: der Aufruf beruehrt ausschliesslich die eigene Person,\ndas Profil kommt aus den Einstellungen und ist nicht frei waehlbar.", "operationId": "post_chatroom_assistant_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Der persoenliche Assistenten-Raum der eingeloggten Person", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } } }, "\/api\/chat\/chatroom\/{identifier}\/support": { "put": { "tags": [ "Chat \/ Chatroom" ], "summary": "Status und Zuweisung eines Support-Raums setzen (chatroom_support_inbox_enabled, sonst 8618).", "description": "Nur gesendete Felder aendern sich, null leert sie. Fehler: 8625 kein Support-Raum, 8626\nunbekannter Status, ungueltiges Datum oder unbekannte Person bzw. Gruppe.", "operationId": "put_chatroom_support_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "status": { "type": "string", "enum": [ "open", "snoozed", "resolved" ] }, "snoozed_until": { "description": "Nur fuer snoozed; leer = bis der Kunde schreibt", "type": "string", "format": "date-time" }, "assigned_user": { "description": "Benutzer-Id, null = niemand", "type": "integer" }, "assigned_group": { "description": "Benutzergruppen-Id, null = keine", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Der Raum mit neuem Status und neuer Zuweisung", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } }, "patch": { "tags": [ "Chat \/ Chatroom" ], "summary": "Status und Zuweisung eines Support-Raums setzen (chatroom_support_inbox_enabled, sonst 8618).", "description": "Nur gesendete Felder aendern sich, null leert sie. Fehler: 8625 kein Support-Raum, 8626\nunbekannter Status, ungueltiges Datum oder unbekannte Person bzw. Gruppe.", "operationId": "patch_chatroom_support_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "status": { "type": "string", "enum": [ "open", "snoozed", "resolved" ] }, "snoozed_until": { "description": "Nur fuer snoozed; leer = bis der Kunde schreibt", "type": "string", "format": "date-time" }, "assigned_user": { "description": "Benutzer-Id, null = niemand", "type": "integer" }, "assigned_group": { "description": "Benutzergruppen-Id, null = keine", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Der Raum mit neuem Status und neuer Zuweisung", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } } }, "\/api\/chat\/chatroom_support_assignees": { "get": { "tags": [ "Chat \/ Chatroom" ], "summary": "Wem ein Support-Raum zugewiesen werden kann: Benutzergruppen mit Lese-Recht auf den Chat und\nihre Benutzer (chatroom_support_inbox_enabled, sonst 8618).", "operationId": "get_chatroom_support_assignees_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "users (id, name, group_id) und groups (id, name)" } } } }, "\/api\/chat\/chatroom\/{identifier}\/merge_visitor": { "post": { "tags": [ "Chat \/ Chatroom" ], "summary": "Den Verlauf eines anonymen Besuchers in den Support-Chat des Haushalts der Person uebernehmen\n(chatroom_support_merge_visitor_enabled, sonst 8618). Der Besucher verliert den Zugang zum\nalten Raum, der geschlossen wird. Fehler: 8627 kein Besucher im Raum, Person ohne Haushalt.", "operationId": "post_chatroom_merge_visitor_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "person": { "description": "CRM-Person, der der Besucher entspricht", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Der Support-Chat des Haushalts mit dem uebernommenen Verlauf", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } } }, "\/api\/chat\/chatroom\/{identifier}\/handover": { "post": { "tags": [ "Chat \/ Chatroom" ], "summary": "Das Team uebernimmt einen Support-Raum: die KI zieht sich zurueck, ohne\ndass schon jemand geschrieben hat (Support-Modus, \"Uebernehmen\").", "operationId": "post_chatroom_handover_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Die KI uebergibt den Raum an das Team", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } }, "delete": { "tags": [ "Chat \/ Chatroom" ], "summary": "Die KI antwortet im Raum wieder.", "operationId": "delete_chatroom_handover_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Die KI antwortet im Raum wieder", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Chatroom4" } } } } } } }, "\/api\/chat\/chatroom_message": { "get": { "tags": [ "Chat \/ ChatroomMessage" ], "summary": "Returns a list of all ChatroomMessages", "operationId": "get_chatroom_message_cget", "parameters": [ { "name": "chatroom", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "participant", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE_LIST, LOGGED_IN_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all ChatroomMessages", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatroomMessage2" } } } } } } }, "post": { "tags": [ "Chat \/ ChatroomMessage" ], "summary": "Add a new ChatroomMessage", "operationId": "post_chatroom_message_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessage3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ChatroomMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessage3" } } } } } } }, "\/api\/chat\/chatroom_message\/{identifier}": { "get": { "tags": [ "Chat \/ ChatroomMessage" ], "summary": "Returns a single ChatroomMessage entry.", "operationId": "get_chatroom_message_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ChatroomMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessage3" } } } } } }, "put": { "tags": [ "Chat \/ ChatroomMessage" ], "summary": "Updates an existing ChatroomMessage entry.", "operationId": "put_chatroom_message_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessage3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatroomMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessage3" } } } } } }, "delete": { "tags": [ "Chat \/ ChatroomMessage" ], "summary": "Delete a single ChatroomMessage", "operationId": "delete_chatroom_message_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ChatroomMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessage3" } } } } } }, "patch": { "tags": [ "Chat \/ ChatroomMessage" ], "summary": "Updates an existing ChatroomMessage entry.", "operationId": "patch_chatroom_message_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessage3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatroomMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessage3" } } } } } } }, "\/api\/chat\/chatroom_message_report": { "get": { "tags": [ "Chat \/ ChatroomMessageReport" ], "summary": "Reported chat messages", "description": "Newest first, at most 200. Query status (open, resolved, dismissed) filters; without it all.", "operationId": "get_chat_chatroom_message_report_cget", "parameters": [ { "name": "status", "in": "query", "description": "open, resolved or dismissed", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of reports with message, room and reporter" } } } }, "\/api\/chat\/chatroom_message_report\/{identifier}": { "put": { "tags": [ "Chat \/ ChatroomMessageReport" ], "summary": "Handle a report", "description": "Body: status (resolved or dismissed), hideMessage (optional, hides the reported message for the members).", "operationId": "put_chat_chatroom_message_report_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "status": { "type": "string" }, "hideMessage": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The report" } } }, "patch": { "tags": [ "Chat \/ ChatroomMessageReport" ], "summary": "Handle a report", "description": "Body: status (resolved or dismissed), hideMessage (optional, hides the reported message for the members).", "operationId": "patch_chat_chatroom_message_report_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "status": { "type": "string" }, "hideMessage": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The report" } } } }, "\/api\/chat\/chatroom_message_reaction": { "get": { "tags": [ "Chat \/ ChatroomMessageReaction" ], "summary": "Returns a list of all ChatroomMessageReactions", "operationId": "get_chatroom_message_reaction_cget", "parameters": [ { "name": "chatroom", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "participant", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "message", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all ChatroomMessageReactions", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction2" } } } } } } }, "post": { "tags": [ "Chat \/ ChatroomMessageReaction" ], "summary": "Add a new ChatroomMessageReaction", "operationId": "post_chatroom_message_reaction_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ChatroomMessageReaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction3" } } } } } } }, "\/api\/chat\/chatroom_message_reaction\/{identifier}": { "get": { "tags": [ "Chat \/ ChatroomMessageReaction" ], "summary": "Returns a single ChatroomMessageReaction entry.", "operationId": "get_chatroom_message_reaction_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ChatroomMessageReaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction3" } } } } } }, "put": { "tags": [ "Chat \/ ChatroomMessageReaction" ], "summary": "Updates an existing ChatroomMessageReaction entry.", "operationId": "put_chatroom_message_reaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatroomMessageReaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction3" } } } } } }, "delete": { "tags": [ "Chat \/ ChatroomMessageReaction" ], "summary": "Delete a single ChatroomMessageReaction", "operationId": "delete_chatroom_message_reaction_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ChatroomMessageReaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction3" } } } } } }, "patch": { "tags": [ "Chat \/ ChatroomMessageReaction" ], "summary": "Updates an existing ChatroomMessageReaction entry.", "operationId": "patch_chatroom_message_reaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatroomMessageReaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction3" } } } } } } }, "\/api\/chat\/chatroom_participant": { "get": { "tags": [ "Chat \/ ChatroomParticipant" ], "summary": "Returns a list of all ChatroomParticipants", "operationId": "get_chatroom_participant_cget", "parameters": [ { "name": "chatroom", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventSignUp", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "participantType", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "chatbotProfile", "in": "query", "description": "Das Profil, aus dem dieser Bot-Teilnehmer seine Vorgaben zieht. Nur bei participantType internal_ai_bot gesetzt. | Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all ChatroomParticipants", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatroomParticipant2" } } } } } } }, "post": { "tags": [ "Chat \/ ChatroomParticipant" ], "summary": "Add a new ChatroomParticipant", "operationId": "post_chatroom_participant_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomParticipant3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ChatroomParticipant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomParticipant3" } } } } } } }, "\/api\/chat\/chatroom_participant\/{identifier}": { "get": { "tags": [ "Chat \/ ChatroomParticipant" ], "summary": "Returns a single ChatroomParticipant entry.", "operationId": "get_chatroom_participant_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ChatroomParticipant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomParticipant3" } } } } } }, "put": { "tags": [ "Chat \/ ChatroomParticipant" ], "summary": "Updates an existing ChatroomParticipant entry.", "operationId": "put_chatroom_participant_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomParticipant3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatroomParticipant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomParticipant3" } } } } } }, "delete": { "tags": [ "Chat \/ ChatroomParticipant" ], "summary": "Delete a single ChatroomParticipant", "operationId": "delete_chatroom_participant_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ChatroomParticipant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomParticipant3" } } } } } }, "patch": { "tags": [ "Chat \/ ChatroomParticipant" ], "summary": "Updates an existing ChatroomParticipant entry.", "operationId": "patch_chatroom_participant_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatroomParticipant3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatroomParticipant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatroomParticipant3" } } } } } } }, "\/api\/chat\/chatbot_profile": { "get": { "tags": [ "Chat \/ ChatbotProfile" ], "summary": "Returns a list of all ChatbotProfiles", "operationId": "get_chat_chatbot_profile_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "admin | member | public - siehe MODE_* Konstanten. Der Modus bestimmt, in welchen Raeumen das Profil ueberhaupt eingesetzt werden darf (Bot-Modus <= Vertrauensstufe des Raums). | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE, SCOPE_LIST | Multiple default values: false, false,", "required": false, "schema": { "type": "boolean" } }, { "name": "replyMode", "in": "query", "description": "always | mention | question - siehe REPLY_MODE_* Konstanten. | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all ChatbotProfiles", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatbotProfile" } } } } } } }, "post": { "tags": [ "Chat \/ ChatbotProfile" ], "summary": "Add a new ChatbotProfile", "operationId": "post_chat_chatbot_profile_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatbotProfile" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ChatbotProfile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatbotProfile" } } } } } } }, "\/api\/chat\/chatbot_profile_tools": { "get": { "tags": [ "Chat \/ ChatbotProfile" ], "summary": "Die MCP-Tools, die ein Profil im angegebenen Modus auswaehlen kann -\nTitel und Beschreibung kommen aus dem eingebauten MCP-Server.", "operationId": "get_chat_chatbot_profile_tools", "parameters": [ { "name": "mode", "in": "query", "description": "admin, member or public", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MCP tools a chatbot profile of the mode may use", "content": { "application\/json": { "schema": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "public": { "type": "boolean" }, "read_only": { "type": "boolean" }, "available": { "description": "switched on in this installation; switched off tools may be selected and work once their setting is on", "type": "boolean" } }, "type": "object" } } } } } } } }, "\/api\/chat\/chatbot_profile\/{identifier}": { "get": { "tags": [ "Chat \/ ChatbotProfile" ], "summary": "Returns a single ChatbotProfile entry.", "operationId": "get_chat_chatbot_profile_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ChatbotProfile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatbotProfile" } } } } } }, "put": { "tags": [ "Chat \/ ChatbotProfile" ], "summary": "Updates an existing ChatbotProfile entry.", "operationId": "put_chat_chatbot_profile_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatbotProfile" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatbotProfile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatbotProfile" } } } } } }, "delete": { "tags": [ "Chat \/ ChatbotProfile" ], "summary": "Delete a single ChatbotProfile", "operationId": "delete_chat_chatbot_profile_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ChatbotProfile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatbotProfile" } } } } } }, "patch": { "tags": [ "Chat \/ ChatbotProfile" ], "summary": "Updates an existing ChatbotProfile entry.", "operationId": "patch_chat_chatbot_profile_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ChatbotProfile" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single ChatbotProfile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatbotProfile" } } } } } } }, "\/api\/chat\/chatbot_consent": { "get": { "tags": [ "Chat \/ ChatbotConsent" ], "summary": "Returns a list of all ChatbotConsents", "operationId": "get_chat_chatbot_consent_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "granted", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "customer_app | admin | import - siehe SOURCE_* Konstanten. | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "textVersion", "in": "query", "description": "Version des Einwilligungstextes (Setting chatbot_member_consent_version). | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all ChatbotConsents", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatbotConsent" } } } } } } } }, "\/api\/chat\/chatbot_consent\/revoke\/{personIdentifier}": { "post": { "tags": [ "Chat \/ ChatbotConsent" ], "summary": "Widerruft das KI-Opt-in einer Person", "operationId": "post_chat_chatbot_consent_revoke_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "personIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Die geschriebene Widerrufs-Zeile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatbotConsent2" } } } } } } }, "\/api\/cp\/app_usage\/statistics": { "get": { "tags": [ "CustomerPanel \/ AppUsageStatistics" ], "summary": "Nutzung der Mitglieder-App in einem Zeitraum", "description": "Ansichten mit Aufrufen, Einstiegen und Ausstiegen, die haeufigsten Wege\nzwischen zwei Ansichten, Plattformen, App-Versionen und Sitzungstiefe.\nZeilen unter der Mindestgroesse (Setting\ncustomer_app_usage_statistics_min_group_size) fehlen und sind in\nhidden_rows gezaehlt.", "operationId": "get_app_usage_statistics_get", "parameters": [ { "name": "from", "in": "query", "description": "Erster Tag (Y-m-d), Standard vor 29 Tagen", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Letzter Tag (Y-m-d), Standard heute", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Auswertung", "content": { "application\/json": { "schema": { "properties": { "enabled": { "type": "boolean" }, "from": { "type": "string" }, "to": { "type": "string" }, "min_group_size": { "type": "integer" }, "totals": { "type": "object" }, "days": { "type": "array", "items": { "type": "object" } }, "routes": { "type": "array", "items": { "type": "object" } }, "transitions": { "type": "array", "items": { "type": "object" } }, "platforms": { "type": "array", "items": { "type": "object" } }, "versions": { "type": "array", "items": { "type": "object" } }, "depth": { "type": "array", "items": { "type": "object" } }, "hidden_rows": { "type": "integer" } }, "type": "object" } } } } } } }, "\/api\/chat\/chatbot_turn_log": { "get": { "tags": [ "Chat \/ ChatbotTurnLog" ], "summary": "Returns a list of all ChatbotTurnLogs", "operationId": "get_chat_chatbot_turn_log_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "chatroom", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "ok | error | skipped - siehe STATUS_* Konstanten. | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "model", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "finishReason", "in": "query", "description": "stop | max_iterations | timeout | error - so, wie der Dienst es meldet. | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all ChatbotTurnLogs", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatbotTurnLog" } } } } } } } }, "\/api\/chat\/chatbot_turn_log\/{identifier}": { "get": { "tags": [ "Chat \/ ChatbotTurnLog" ], "summary": "Returns a single ChatbotTurnLog entry.", "operationId": "get_chat_chatbot_turn_log_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single ChatbotTurnLog", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ChatbotTurnLog" } } } } } } }, "\/api\/chat\/chatbot_usage": { "get": { "tags": [ "Chat \/ ChatbotUsage" ], "summary": "Nutzung der KI-Assistenten in einem Zeitraum", "operationId": "get_chat_chatbot_usage_get", "parameters": [ { "name": "from", "in": "query", "description": "Beginn des Zeitraums, YYYY-MM-DD", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Ende des Zeitraums, YYYY-MM-DD", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Lokale Tageswerte und - wenn erreichbar - die Zaehlung des LLM-Dienstes", "content": { "application\/json": { "schema": { "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "local": { "type": "object" }, "service": { "type": "object", "nullable": true } }, "type": "object" } } } } } } }, "\/api\/crm\/subscription\/item": { "get": { "tags": [ "CRM \/ SubscriptionItem" ], "summary": "Returns a list of SubscriptionItem", "operationId": "get_crm_subscription_item_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of SubscriptionItem", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SubscriptionItem" } } } } } } }, "post": { "tags": [ "CRM \/ SubscriptionItem" ], "summary": "Create a single SubscriptionItem", "operationId": "post_crm_subscription_item_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SubscriptionItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single SubscriptionItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionItem3" } } } } } } }, "\/api\/crm\/subscription\/item\/{id}": { "get": { "tags": [ "CRM \/ SubscriptionItem" ], "summary": "Returns a single SubscriptionItem with the given id", "operationId": "get_crm_subscription_item_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single SubscriptionItem with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionItem3" } } } } } }, "put": { "tags": [ "CRM \/ SubscriptionItem" ], "summary": "Update a single SubscriptionItem", "operationId": "put_crm_subscription_item_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SubscriptionItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single SubscriptionItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionItem3" } } } } } }, "patch": { "tags": [ "CRM \/ SubscriptionItem" ], "summary": "Update a single SubscriptionItem", "operationId": "patch_crm_subscription_item_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SubscriptionItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single SubscriptionItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SubscriptionItem3" } } } } } } }, "\/api\/crm\/event-access-budget": { "get": { "tags": [ "CRM \/ EventAccessBudget" ], "summary": "Returns a list of EventAccessBudget", "operationId": "get_crm_event_access_budget_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Scope: limit budget to a specific event | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "unifiedCategory", "in": "query", "description": "Scope: limit budget to events of this unified category | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "Scope: limit budget to events of this event type (WORKSHOP, CAMP, COURSE, etc.) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sourceType", "in": "query", "description": "How this budget was created: 'purchase', 'bonus', 'manual' | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sourceProduct", "in": "query", "description": "The product that created this budget (if purchased) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sourceInvoice", "in": "query", "description": "The invoice whose payment triggered budget creation | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "validFrom", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "validUntil", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "trialPolicy", "in": "query", "description": "Rule of a trial pass (sourceType trial) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "trialStatus", "in": "query", "description": "active, exhausted (all dates used and over), converted (course place or membership), expired (validity over), cancelled (ended by the office) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "trialExhaustedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "trialFollowUpSentAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "trialConvertedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EventAccessBudget objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventAccessBudget" } } } } } } }, "post": { "tags": [ "CRM \/ EventAccessBudget" ], "summary": "Create a single EventAccessBudget", "operationId": "post_crm_event_access_budget_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventAccessBudget2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single EventAccessBudget", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventAccessBudget" } } } } } } }, "\/api\/crm\/event-access-budget\/{id}": { "get": { "tags": [ "CRM \/ EventAccessBudget" ], "summary": "Returns a single EventAccessBudget with the given id", "operationId": "get_crm_event_access_budget_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EventAccessBudget with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventAccessBudget" } } } } } }, "put": { "tags": [ "CRM \/ EventAccessBudget" ], "summary": "Update a single EventAccessBudget", "description": "Changing usedBudget needs at least admin rights and is answered with error code 7063\nonce, so the change has to be confirmed by repeating the request with that code in\nthe x-ignore-iw-error-code header. Without admin rights it is refused with 7062.", "operationId": "put_crm_event_access_budget_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventAccessBudget2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single EventAccessBudget", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventAccessBudget" } } } } } }, "delete": { "tags": [ "CRM \/ EventAccessBudget" ], "summary": "Delete a single EventAccessBudget (soft delete)", "operationId": "delete_crm_event_access_budget_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single EventAccessBudget", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventAccessBudget3" } } } } } }, "patch": { "tags": [ "CRM \/ EventAccessBudget" ], "summary": "Update a single EventAccessBudget", "description": "Changing usedBudget needs at least admin rights and is answered with error code 7063\nonce, so the change has to be confirmed by repeating the request with that code in\nthe x-ignore-iw-error-code header. Without admin rights it is refused with 7062.", "operationId": "patch_crm_event_access_budget_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventAccessBudget2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single EventAccessBudget", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventAccessBudget" } } } } } } }, "\/api\/crm\/studio_training\/person_data": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPersonData" ], "summary": "Returns a list of StudioTrainingPersonData objects", "operationId": "get_crm_studio_training_person_data_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "personalTrainer", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "weight", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "trainerNotes", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioTrainingPersonData objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingPersonData" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPersonData" ], "summary": "Create a single StudioTrainingPersonData", "operationId": "post_crm_studio_training_person_data_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPersonData2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioTrainingPersonData", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPersonData" } } } } } } }, "\/api\/crm\/studio_training\/person_data\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPersonData" ], "summary": "Returns a single StudioTrainingPersonData", "operationId": "get_crm_studio_training_person_data_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioTrainingPersonData", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPersonData" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPersonData" ], "summary": "Update a single StudioTrainingPersonData", "operationId": "put_crm_studio_training_person_data_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPersonData2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingPersonData", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPersonData" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPersonData" ], "summary": "Delete a single StudioTrainingPersonData (soft delete)", "operationId": "delete_crm_studio_training_person_data_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioTrainingPersonData", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPersonData" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPersonData" ], "summary": "Update a single StudioTrainingPersonData", "operationId": "patch_crm_studio_training_person_data_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPersonData2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingPersonData", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPersonData" } } } } } } }, "\/api\/crm\/studio_training\/plan": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlan" ], "summary": "Returns a list of StudioTrainingPlan objects", "operationId": "get_crm_studio_training_plan_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "trainingPersonData", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "timesPerWeek", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "One of the STATUS_* constants | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isTemplate", "in": "query", "description": "True for reusable templates that are not bound to a training person | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "validFrom", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "validUntil", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reviewDate", "in": "query", "description": "Date the plan should be reviewed with the member (Wiedervorlage) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "trainingGoal", "in": "query", "description": "Training goal of the plan, e.g. muscle building, weight loss, rehab | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioTrainingPlan objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlan" ], "summary": "Create a single StudioTrainingPlan", "operationId": "post_crm_studio_training_plan_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioTrainingPlan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } } } } } } }, "\/api\/crm\/studio_training\/plan\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlan" ], "summary": "Returns a single StudioTrainingPlan", "operationId": "get_crm_studio_training_plan_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioTrainingPlan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlan" ], "summary": "Update a single StudioTrainingPlan", "operationId": "put_crm_studio_training_plan_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingPlan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlan" ], "summary": "Delete a single StudioTrainingPlan (soft delete)", "operationId": "delete_crm_studio_training_plan_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioTrainingPlan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlan" ], "summary": "Update a single StudioTrainingPlan", "operationId": "patch_crm_studio_training_plan_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingPlan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } } } } } } }, "\/api\/crm\/studio_training\/preset": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPreset" ], "summary": "Returns a list of StudioTrainingPreset objects", "operationId": "get_crm_studio_training_preset_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "duration", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "exerciseType", "in": "query", "description": "Category of the exercise, e.g. strength, cardio, mobility, rehab | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "equipment", "in": "query", "description": "Required equipment as free text, e.g. barbell, cable machine, bodyweight | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contentSource", "in": "query", "description": "One of the CONTENT_SOURCE_* constants | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reviewStatus", "in": "query", "description": "One of the REVIEW_STATUS_* constants, used to keep generated or imported exercise instructions under human control before they are published | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "importOriginId", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioTrainingPreset objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPreset" ], "summary": "Create a single StudioTrainingPreset", "operationId": "post_crm_studio_training_preset_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioTrainingPreset", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } } } } } } }, "\/api\/crm\/studio_training\/preset\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPreset" ], "summary": "Returns a single StudioTrainingPreset", "operationId": "get_crm_studio_training_preset_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioTrainingPreset", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPreset" ], "summary": "Update a single StudioTrainingPreset", "operationId": "put_crm_studio_training_preset_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingPreset", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPreset" ], "summary": "Delete a single StudioTrainingPreset (soft delete)", "operationId": "delete_crm_studio_training_preset_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioTrainingPreset", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPreset" ], "summary": "Update a single StudioTrainingPreset", "operationId": "patch_crm_studio_training_preset_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingPreset", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } } } } } } }, "\/api\/crm\/studio_training\/device": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioDevice" ], "summary": "Returns a list of StudioDevice objects", "operationId": "get_crm_studio_training_device_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "manufacturer", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "model", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deviceType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioDevice objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioDevice" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioDevice" ], "summary": "Create a single StudioDevice", "operationId": "post_crm_studio_training_device_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioDevice" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioDevice" } } } } } } }, "\/api\/crm\/studio_training\/device\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioDevice" ], "summary": "Returns a single StudioDevice", "operationId": "get_crm_studio_training_device_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioDevice" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioDevice" ], "summary": "Update a single StudioDevice", "operationId": "put_crm_studio_training_device_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioDevice" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioDevice" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioDevice" ], "summary": "Delete a single StudioDevice (soft delete)", "operationId": "delete_crm_studio_training_device_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioDevice" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioDevice" ], "summary": "Update a single StudioDevice", "operationId": "patch_crm_studio_training_device_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioDevice" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioDevice" } } } } } } }, "\/api\/crm\/studio_training\/device_setup": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioDeviceSetup" ], "summary": "Returns a list of StudioDeviceSetup objects", "operationId": "get_crm_studio_training_device_setup_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "trainingPersonData", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "device", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "preset", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioDeviceSetup objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioDeviceSetup" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioDeviceSetup" ], "summary": "Create a single StudioDeviceSetup", "operationId": "post_crm_studio_training_device_setup_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioDeviceSetup" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioDeviceSetup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioDeviceSetup" } } } } } } }, "\/api\/crm\/studio_training\/device_setup\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioDeviceSetup" ], "summary": "Returns a single StudioDeviceSetup", "operationId": "get_crm_studio_training_device_setup_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioDeviceSetup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioDeviceSetup" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioDeviceSetup" ], "summary": "Update a single StudioDeviceSetup", "operationId": "put_crm_studio_training_device_setup_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioDeviceSetup" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioDeviceSetup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioDeviceSetup" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioDeviceSetup" ], "summary": "Delete a single StudioDeviceSetup (soft delete)", "operationId": "delete_crm_studio_training_device_setup_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioDeviceSetup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioDeviceSetup" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioDeviceSetup" ], "summary": "Update a single StudioDeviceSetup", "operationId": "patch_crm_studio_training_device_setup_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioDeviceSetup" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioDeviceSetup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioDeviceSetup" } } } } } } }, "\/api\/crm\/studio_training\/muscle_group": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMuscleGroup" ], "summary": "Returns a list of StudioTrainingMuscleGroup objects", "operationId": "get_crm_studio_training_muscle_group_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bodyMarkerKey", "in": "query", "description": "Short identifier used by clients to map the group to a body diagram area | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isFront", "in": "query", "description": "True if the muscle group is shown on the front side of the body diagram | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioTrainingMuscleGroup objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMuscleGroup" ], "summary": "Create a single StudioTrainingMuscleGroup", "operationId": "post_crm_studio_training_muscle_group_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioTrainingMuscleGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } } } } } } }, "\/api\/crm\/studio_training\/muscle_group\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMuscleGroup" ], "summary": "Returns a single StudioTrainingMuscleGroup", "operationId": "get_crm_studio_training_muscle_group_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioTrainingMuscleGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMuscleGroup" ], "summary": "Update a single StudioTrainingMuscleGroup", "operationId": "put_crm_studio_training_muscle_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingMuscleGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMuscleGroup" ], "summary": "Delete a single StudioTrainingMuscleGroup (soft delete)", "operationId": "delete_crm_studio_training_muscle_group_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioTrainingMuscleGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMuscleGroup" ], "summary": "Update a single StudioTrainingMuscleGroup", "operationId": "patch_crm_studio_training_muscle_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingMuscleGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } } } } } } }, "\/api\/crm\/studio_training\/challenge": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingChallenge" ], "summary": "Returns a list of StudioTrainingChallenge objects", "operationId": "get_crm_studio_training_challenge_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "First moment that counts | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "description": "Last moment that counts | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "metric", "in": "query", "description": "What is counted: training_days, sessions or checkins | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioTrainingChallenge objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingChallenge" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingChallenge" ], "summary": "Create a single StudioTrainingChallenge", "operationId": "post_crm_studio_training_challenge_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingChallenge" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioTrainingChallenge", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingChallenge" } } } } } } }, "\/api\/crm\/studio_training\/challenge\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingChallenge" ], "summary": "Returns a single StudioTrainingChallenge", "operationId": "get_crm_studio_training_challenge_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioTrainingChallenge", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingChallenge" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingChallenge" ], "summary": "Update a single StudioTrainingChallenge", "operationId": "put_crm_studio_training_challenge_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingChallenge" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingChallenge", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingChallenge" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingChallenge" ], "summary": "Delete a single StudioTrainingChallenge (soft delete)", "operationId": "delete_crm_studio_training_challenge_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioTrainingChallenge", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingChallenge" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingChallenge" ], "summary": "Update a single StudioTrainingChallenge", "operationId": "patch_crm_studio_training_challenge_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingChallenge" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingChallenge", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingChallenge" } } } } } } }, "\/api\/crm\/studio_training\/plan_day": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanDay" ], "summary": "Returns a list of StudioTrainingPlanDay objects", "operationId": "get_crm_studio_training_plan_day_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "plan", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "dayOfWeek", "in": "query", "description": "Optional fixed weekday (1 = Monday ... 7 = Sunday) if the plan is bound to weekdays | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioTrainingPlanDay objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanDay" ], "summary": "Create a single StudioTrainingPlanDay", "operationId": "post_crm_studio_training_plan_day_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioTrainingPlanDay", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } } } } } } }, "\/api\/crm\/studio_training\/plan_day\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanDay" ], "summary": "Returns a single StudioTrainingPlanDay", "operationId": "get_crm_studio_training_plan_day_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioTrainingPlanDay", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanDay" ], "summary": "Update a single StudioTrainingPlanDay", "operationId": "put_crm_studio_training_plan_day_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingPlanDay", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanDay" ], "summary": "Delete a single StudioTrainingPlanDay (soft delete)", "operationId": "delete_crm_studio_training_plan_day_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioTrainingPlanDay", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanDay" ], "summary": "Update a single StudioTrainingPlanDay", "operationId": "patch_crm_studio_training_plan_day_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingPlanDay", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } } } } } } }, "\/api\/crm\/studio_training\/plan_exercise": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanExercise" ], "summary": "Returns a list of StudioTrainingPlanExercise objects", "operationId": "get_crm_studio_training_plan_exercise_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "planDay", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "preset", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "device", "in": "query", "description": "Optional concrete machine for this exercise | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "circuitGroup", "in": "query", "description": "Exercises of the same day sharing this key form a superset \/ circuit block | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioTrainingPlanExercise objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingPlanExercise" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanExercise" ], "summary": "Create a single StudioTrainingPlanExercise", "operationId": "post_crm_studio_training_plan_exercise_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPlanExercise" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioTrainingPlanExercise", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlanExercise" } } } } } } }, "\/api\/crm\/studio_training\/plan_exercise\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanExercise" ], "summary": "Returns a single StudioTrainingPlanExercise", "operationId": "get_crm_studio_training_plan_exercise_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioTrainingPlanExercise", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlanExercise" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanExercise" ], "summary": "Update a single StudioTrainingPlanExercise", "operationId": "put_crm_studio_training_plan_exercise_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPlanExercise" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingPlanExercise", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlanExercise" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanExercise" ], "summary": "Delete a single StudioTrainingPlanExercise (soft delete)", "operationId": "delete_crm_studio_training_plan_exercise_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioTrainingPlanExercise", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlanExercise" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingPlanExercise" ], "summary": "Update a single StudioTrainingPlanExercise", "operationId": "patch_crm_studio_training_plan_exercise_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingPlanExercise" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingPlanExercise", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingPlanExercise" } } } } } } }, "\/api\/crm\/studio_training\/session": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSession" ], "summary": "Returns a list of StudioTrainingSession objects", "operationId": "get_crm_studio_training_session_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "trainingPersonData", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "plan", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "planDay", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "trainer", "in": "query", "description": "Trainer who supervised the unit, if any | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "performedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioTrainingSession objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingSession" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSession" ], "summary": "Create a single StudioTrainingSession", "operationId": "post_crm_studio_training_session_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingSession2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioTrainingSession", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingSession" } } } } } } }, "\/api\/crm\/studio_training\/session\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSession" ], "summary": "Returns a single StudioTrainingSession", "operationId": "get_crm_studio_training_session_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioTrainingSession", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingSession" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSession" ], "summary": "Update a single StudioTrainingSession", "operationId": "put_crm_studio_training_session_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingSession2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingSession", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingSession" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSession" ], "summary": "Delete a single StudioTrainingSession (soft delete)", "operationId": "delete_crm_studio_training_session_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioTrainingSession", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingSession" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSession" ], "summary": "Update a single StudioTrainingSession", "operationId": "patch_crm_studio_training_session_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingSession2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingSession", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingSession" } } } } } } }, "\/api\/crm\/studio_training\/session_entry": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSessionEntry" ], "summary": "Returns a list of StudioTrainingSessionEntry objects", "operationId": "get_crm_studio_training_session_entry_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "session", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "planExercise", "in": "query", "description": "Prescription this entry was performed against, if the unit followed a plan | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "preset", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "device", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "setNumber", "in": "query", "description": "Number of the set within the exercise, starting at 1 | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioTrainingSessionEntry objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingSessionEntry" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSessionEntry" ], "summary": "Create a single StudioTrainingSessionEntry", "operationId": "post_crm_studio_training_session_entry_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingSessionEntry" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioTrainingSessionEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingSessionEntry" } } } } } } }, "\/api\/crm\/studio_training\/session_entry\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSessionEntry" ], "summary": "Returns a single StudioTrainingSessionEntry", "operationId": "get_crm_studio_training_session_entry_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioTrainingSessionEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingSessionEntry" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSessionEntry" ], "summary": "Update a single StudioTrainingSessionEntry", "operationId": "put_crm_studio_training_session_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingSessionEntry" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingSessionEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingSessionEntry" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSessionEntry" ], "summary": "Delete a single StudioTrainingSessionEntry (soft delete)", "operationId": "delete_crm_studio_training_session_entry_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioTrainingSessionEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingSessionEntry" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingSessionEntry" ], "summary": "Update a single StudioTrainingSessionEntry", "operationId": "patch_crm_studio_training_session_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingSessionEntry" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingSessionEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingSessionEntry" } } } } } } }, "\/api\/crm\/studio_training\/measurement": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMeasurement" ], "summary": "Returns a list of StudioTrainingMeasurement objects", "operationId": "get_crm_studio_training_measurement_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "trainingPersonData", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "preset", "in": "query", "description": "Preset the measurement belongs to, used for strength test values | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "measuredAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "measurementType", "in": "query", "description": "One of the TYPE_* constants | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "One of the SOURCE_* constants | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StudioTrainingMeasurement objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingMeasurement" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMeasurement" ], "summary": "Create a single StudioTrainingMeasurement", "operationId": "post_crm_studio_training_measurement_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingMeasurement" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single StudioTrainingMeasurement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingMeasurement" } } } } } } }, "\/api\/crm\/studio_training\/measurement\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMeasurement" ], "summary": "Returns a single StudioTrainingMeasurement", "operationId": "get_crm_studio_training_measurement_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StudioTrainingMeasurement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingMeasurement" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMeasurement" ], "summary": "Update a single StudioTrainingMeasurement", "operationId": "put_crm_studio_training_measurement_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingMeasurement" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingMeasurement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingMeasurement" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMeasurement" ], "summary": "Delete a single StudioTrainingMeasurement (soft delete)", "operationId": "delete_crm_studio_training_measurement_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single StudioTrainingMeasurement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingMeasurement" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ StudioTrainingMeasurement" ], "summary": "Update a single StudioTrainingMeasurement", "operationId": "patch_crm_studio_training_measurement_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StudioTrainingMeasurement" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single StudioTrainingMeasurement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StudioTrainingMeasurement" } } } } } } }, "\/api\/crm\/studio_training\/own\/overview": { "get": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Overview of the own training: profile, active plan, visible plans and key figures", "operationId": "get_crm_studio_training_own_overview", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "person_data, active_plan, plans, summary, weekly_sessions, last_session, member_edit_hours", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/own\/plan": { "get": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Own plans (active and archived, drafts stay with the trainer)", "operationId": "get_crm_studio_training_own_plan_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of StudioTrainingPlan", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } } }, "\/api\/crm\/studio_training\/own\/plan\/{identifier}\/tree": { "get": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "One own plan with its days, exercises and catalogue entries", "operationId": "get_crm_studio_training_own_plan_tree", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "plan, days, exercises, presets", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/own\/plan_day\/{identifier}\/last_performance": { "get": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "The sets of the last session per exercise of a plan day, used to prefill a workout", "operationId": "get_crm_studio_training_own_plan_day_last_performance", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of plan_exercise_id, preset_id, session_id, performed_at, sets", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } } }, "\/api\/crm\/studio_training\/own\/session": { "get": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Own session log, newest first", "operationId": "get_crm_studio_training_own_session_cget", "parameters": [ { "name": "page", "in": "query", "description": "Page, starting with 1", "required": false, "schema": { "type": "integer" } }, { "name": "pageSize", "in": "query", "description": "Page size, default 30, at most 200", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of StudioTrainingSession", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Log a session with all sets", "operationId": "post_crm_studio_training_own_session_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "description": "data: session fields (snake_case) plus entries, a list of sets", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "session, entries, editable_until", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/own\/session\/{identifier}": { "get": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "One own session with all sets", "operationId": "get_crm_studio_training_own_session_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "session, entries, editable_until", "content": { "application\/json": { "schema": { "type": "object" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Correct an own session. Only sessions logged in the member app, within the correction period.", "operationId": "put_crm_studio_training_own_session_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data: session fields (snake_case) plus entries, a list of sets, which replaces all sets", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "session, entries, editable_until", "content": { "application\/json": { "schema": { "type": "object" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Delete an own session. Only sessions logged in the member app, within the correction period.", "operationId": "delete_crm_studio_training_own_session_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The deleted StudioTrainingSession", "content": { "application\/json": { "schema": { "type": "object" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Correct an own session. Only sessions logged in the member app, within the correction period.", "operationId": "patch_crm_studio_training_own_session_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data: session fields (snake_case) plus entries, a list of sets, which replaces all sets", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "session, entries, editable_until", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/own\/measurement": { "get": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Own body values and test results", "operationId": "get_crm_studio_training_own_measurement_cget", "parameters": [ { "name": "measurementType", "in": "query", "description": "One of the StudioTrainingMeasurement TYPE_* constants", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page, starting with 1", "required": false, "schema": { "type": "integer" } }, { "name": "pageSize", "in": "query", "description": "Page size, default 30, at most 200", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of StudioTrainingMeasurement", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } }, "post": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Record an own body value (weight, girth, resting heart rate)", "operationId": "post_crm_studio_training_own_measurement_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "description": "data: measurement_type, value, unit, body_site, measured_at, notes", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "The new StudioTrainingMeasurement", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/own\/measurement\/{identifier}": { "put": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Correct an own body value within the correction period", "operationId": "put_crm_studio_training_own_measurement_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data: value, unit, body_site, measured_at, notes", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "The StudioTrainingMeasurement", "content": { "application\/json": { "schema": { "type": "object" } } } } } }, "delete": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Delete an own body value within the correction period", "operationId": "delete_crm_studio_training_own_measurement_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The deleted StudioTrainingMeasurement", "content": { "application\/json": { "schema": { "type": "object" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Correct an own body value within the correction period", "operationId": "patch_crm_studio_training_own_measurement_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data: value, unit, body_site, measured_at, notes", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "The StudioTrainingMeasurement", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/own\/device_setup": { "get": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Own device setups (seat positions, lever settings, ...)", "operationId": "get_crm_studio_training_own_device_setup_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of StudioDeviceSetup", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } } }, "\/api\/crm\/studio_training\/own\/progress": { "get": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Own progress: session summary, sessions per week, per exercise series and measurement series", "operationId": "get_crm_studio_training_own_progress", "parameters": [ { "name": "days", "in": "query", "description": "History window in days, default 365", "required": false, "schema": { "type": "integer" } }, { "name": "preset", "in": "query", "description": "Limit the exercise series to one StudioTrainingPreset id", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "summary, weekly_sessions, exercises, measurements", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/own\/gamification": { "get": { "tags": [ "CRM \/ StudioTraining \/ Own" ], "summary": "Own gamification: training streak, badges and the running challenges with the own progress.", "description": "Counts the recorded trainings and, depending on the settings, the check-ins of attendance\nlists, so members without training data take part with their check-ins.", "operationId": "get_crm_studio_training_own_gamification", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "summary, badges, challenges", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/plan\/{identifier}\/tree": { "get": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "A plan with its days, exercises and the referenced catalogue entries", "operationId": "get_crm_studio_training_plan_tree", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "plan, days, exercises, presets", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/plan\/{identifier}\/copy": { "post": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "Copy a plan: template to a member plan, member plan to a template, or a duplicate", "operationId": "post_crm_studio_training_plan_copy", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data: training_person_data (target member, omit for a template), as_template (bool), name, status", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "plan, days, exercises, presets of the copy", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/plan\/{identifier}\/reorder_days": { "post": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "Store the order of the days of a plan", "operationId": "post_crm_studio_training_plan_reorder_days", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data: ids, the plan day ids in the new order", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "List of StudioTrainingPlanDay", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } } }, "\/api\/crm\/studio_training\/plan_day\/{identifier}\/reorder_exercises": { "post": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "Store the order of the exercises of a plan day, exercises may be moved in from another day of the same plan", "operationId": "post_crm_studio_training_plan_day_reorder_exercises", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data: ids, the plan exercise ids in the new order", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "List of StudioTrainingPlanExercise", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } } }, "\/api\/crm\/studio_training\/session\/{identifier}\/with_entries": { "get": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "A session with all sets", "operationId": "get_crm_studio_training_session_with_entries_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "session, entries", "content": { "application\/json": { "schema": { "type": "object" } } } } } }, "put": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "Update a session and replace all its sets", "operationId": "put_crm_studio_training_session_with_entries_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data: session fields (snake_case) plus entries, a list of sets", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "session, entries", "content": { "application\/json": { "schema": { "type": "object" } } } } } }, "patch": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "Update a session and replace all its sets", "operationId": "patch_crm_studio_training_session_with_entries_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data: session fields (snake_case) plus entries, a list of sets", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "session, entries", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/session\/with_entries": { "post": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "Document a session with all sets for a training person", "operationId": "post_crm_studio_training_session_with_entries_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "description": "data: training_person_data, session fields (snake_case) plus entries, a list of sets", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "session, entries", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/person_data\/{identifier}\/progress": { "get": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "Progress of a training person: session summary, sessions per week, per exercise series and measurement series", "operationId": "get_crm_studio_training_person_data_progress", "parameters": [ { "name": "days", "in": "query", "description": "History window in days, default 365", "required": false, "schema": { "type": "integer" } }, { "name": "preset", "in": "query", "description": "Limit the exercise series to one StudioTrainingPreset id", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "summary, weekly_sessions, exercises, measurements", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/person_data\/{identifier}\/last_performance": { "get": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "The sets of the last session per exercise of a plan day of the training person", "operationId": "get_crm_studio_training_person_data_last_performance", "parameters": [ { "name": "planDay", "in": "query", "description": "StudioTrainingPlanDay id", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of plan_exercise_id, preset_id, session_id, performed_at, sets", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } } }, "\/api\/crm\/studio_training\/linked_members": { "get": { "tags": [ "CRM \/ StudioTraining \/ Actions" ], "summary": "The members the logged in person looks after as personal trainer, with active plan and key figures", "operationId": "get_crm_studio_training_linked_members_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of person_data, active_plan, last_session_at, sessions_last_28_days, review_date", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } } }, "\/api\/crm\/studio_training\/catalogue_source": { "get": { "tags": [ "CRM \/ StudioTraining \/ Catalogue" ], "summary": "The available catalogue sources", "operationId": "get_crm_studio_training_catalogue_source_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of key, name, description, website_url, license, languages, imported_count", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } } } }, "\/api\/crm\/studio_training\/catalogue_source\/{sourceKey}\/exercise": { "get": { "tags": [ "CRM \/ StudioTraining \/ Catalogue" ], "summary": "Browse the exercises of a source to select the ones to import", "operationId": "get_crm_studio_training_catalogue_source_exercise_cget", "parameters": [ { "name": "search", "in": "query", "description": "Part of the name", "required": false, "schema": { "type": "string" } }, { "name": "muscle", "in": "query", "description": "Body marker key of a muscle group", "required": false, "schema": { "type": "string" } }, { "name": "equipment", "in": "query", "description": "Part of an equipment name", "required": false, "schema": { "type": "string" } }, { "name": "exerciseType", "in": "query", "description": "strength, cardio, mobility, plyometrics", "required": false, "schema": { "type": "string" } }, { "name": "onlyNew", "in": "query", "description": "Hide exercises that were imported before", "required": false, "schema": { "type": "boolean" } }, { "name": "refresh", "in": "query", "description": "Reload the catalogue from the source instead of the daily cache", "required": false, "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "description": "Page, starting with 1", "required": false, "schema": { "type": "integer" } }, { "name": "pageSize", "in": "query", "description": "Page size, default 50, at most 200", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "sourceKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "source, total, page, page_size, facets, exercises", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/catalogue_source\/{sourceKey}\/import": { "post": { "tags": [ "CRM \/ StudioTraining \/ Catalogue" ], "summary": "Import the selected exercises of a source as presets (review status pending)", "operationId": "post_crm_studio_training_catalogue_source_import", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "sourceKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "data: external_ids (list, at most 100 per request), import_images (bool), update_existing (bool), language (de or en)", "content": { "application\/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "created, updated, skipped, images, errors, preset_ids", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/studio_training\/muscle_group_defaults": { "post": { "tags": [ "CRM \/ StudioTraining \/ Catalogue" ], "summary": "Create the missing standard muscle groups of the body diagram", "operationId": "post_crm_studio_training_muscle_group_defaults_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "created, existing (body marker keys)", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/category\/unified": { "get": { "tags": [ "CRM \/ Unified Categories" ], "summary": "Returns a list of unified categories", "operationId": "get_crm_unified_category_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "categoryType", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "slugIdentifier", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "viewOrder", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "isUiFilter", "in": "query", "description": "This property is used to mark an entity as a filter for the frontend | Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of unified categories", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory" } } } } } } }, "post": { "tags": [ "CRM \/ Unified Categories" ], "summary": "Add a new unified category", "operationId": "post_crm_unified_category_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "create_access_tag", "in": "query", "description": "1: also create an access tag with the name of the category and link it (needs the write right on settings)", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new unified category", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedCategory" } } } } } } }, "\/api\/crm\/public\/category\/unified": { "get": { "tags": [ "CRM \/ Unified Categories" ], "summary": "Returns a list of public unified categories", "operationId": "get_crm_unified_category_public", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "categoryType", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "slugIdentifier", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "viewOrder", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "isUiFilter", "in": "query", "description": "This property is used to mark an entity as a filter for the frontend | Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of public unified categories", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory3" } } } } } } } }, "\/api\/crm\/public\/category\/unified\/{id}": { "get": { "tags": [ "CRM \/ Unified Categories" ], "summary": "Return a single public unified category with the given id", "operationId": "get_crm_unified_category_public_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a single public unified category with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedCategory" } } } } } } }, "\/api\/crm\/category\/unified\/{id}": { "get": { "tags": [ "CRM \/ Unified Categories" ], "summary": "Return a single unified category with the given id", "operationId": "get_crm_unified_category_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a single unified category with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedCategory" } } } } } }, "put": { "tags": [ "CRM \/ Unified Categories" ], "summary": "Update a single unified category with the given id", "operationId": "put_crm_unified_category_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single unified category with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedCategory" } } } } } }, "patch": { "tags": [ "CRM \/ Unified Categories" ], "summary": "Update a single unified category with the given id", "operationId": "patch_crm_unified_category_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single unified category with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedCategory" } } } } } } }, "\/api\/crm\/unified_tag": { "get": { "tags": [ "CRM \/ Unified Tags" ], "summary": "Returns a list of unified tags", "operationId": "get_crm_unified_tag_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of unified tags", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag" } } } } } } }, "post": { "tags": [ "CRM \/ Unified Tags" ], "summary": "Add a new unified tag", "operationId": "post_crm_unified_tag_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/UnifiedTag2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new unified tag", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedTag" } } } } } } }, "\/api\/crm\/unified_tag\/{id}": { "get": { "tags": [ "CRM \/ Unified Tags" ], "summary": "Return a single unified tag with the given id", "operationId": "get_crm_unified_tag_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a single unified tag with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedTag" } } } } } }, "put": { "tags": [ "CRM \/ Unified Tags" ], "summary": "Update a single unified tag with the given id", "operationId": "put_crm_unified_tag_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/UnifiedTag2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single unified tag with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedTag" } } } } } }, "patch": { "tags": [ "CRM \/ Unified Tags" ], "summary": "Update a single unified tag with the given id", "operationId": "patch_crm_unified_tag_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/UnifiedTag2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single unified tag with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedTag" } } } } } } }, "\/api\/crm\/public\/tag\/unified": { "get": { "tags": [ "CRM \/ Unified Tags" ], "summary": "Returns a list of public unified tags", "operationId": "get_crm_unified_tag_public", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, PUBLIC_LIST, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of public unified tags", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag3" } } } } } } } }, "\/api\/crm\/unified_category_extended\/{id}": { "get": { "tags": [ "CRM \/ Unified Categories" ], "summary": "Return a single unified category extension with the given unified category id", "operationId": "get_crm_unified_category_extension_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a single unified category extension with the given unified category id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedCategoryExtension" } } } } } }, "put": { "tags": [ "CRM \/ Unified Categories" ], "summary": "Update a single unified category extension with the given unified category id", "operationId": "put_crm_unified_category_extension_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/UnifiedCategoryExtension2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single unified category extension with the given unified category id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UnifiedCategoryExtension" } } } } } } }, "\/api\/crm\/person_log_book_entry": { "get": { "tags": [ "CRM \/ PersonLogBookEntry" ], "summary": "Returns a list of all PersonLogBookEntry", "operationId": "get_crm_person_log_book_entry_cget", "parameters": [ { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "unifiedCategory", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "product", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "content", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "discountProduct", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "discountStart", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "discountEnd", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "passiveProduct", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "passiveStart", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "passiveEnd", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "freeProduct", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "freeStart", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "freeEnd", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startBilling", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all PersonLogBookEntry", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PersonLogBookEntry" } } } } } } }, "post": { "tags": [ "CRM \/ PersonLogBookEntry" ], "summary": "Add a new PersonLogBookEntry", "operationId": "post_crm_person_log_book_entry_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PersonLogBookEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new PersonLogBookEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PersonLogBookEntry2" } } } } } } }, "\/api\/crm\/person_log_book_entry\/{identifier}": { "get": { "tags": [ "CRM \/ PersonLogBookEntry" ], "summary": "Get a single PersonLogBookEntry with the given id or token", "operationId": "get_crm_person_log_book_entry_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single PersonLogBookEntry with the given id or token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PersonLogBookEntry2" } } } } } }, "put": { "tags": [ "CRM \/ PersonLogBookEntry" ], "summary": "Update a PersonLogBookEntry", "operationId": "put_crm_person_log_book_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PersonLogBookEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a PersonLogBookEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PersonLogBookEntry2" } } } } } }, "delete": { "tags": [ "CRM \/ PersonLogBookEntry" ], "summary": "Delete a single PersonLogBookEntry with the given id or token", "operationId": "delete_crm_person_log_book_entry_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single PersonLogBookEntry with the given id or token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PersonLogBookEntry2" } } } } } }, "patch": { "tags": [ "CRM \/ PersonLogBookEntry" ], "summary": "Update a PersonLogBookEntry", "operationId": "patch_crm_person_log_book_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PersonLogBookEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a PersonLogBookEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PersonLogBookEntry2" } } } } } } }, "\/api\/crm\/membership_pause_request\/{id}\/decide": { "put": { "tags": [ "CRM \/ MembershipPauseRequest" ], "summary": "Approve (writes the pause into the membership) or decline a membership pause", "operationId": "put_put_membership_pause_request_decide", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "decision", "in": "query", "description": "APPROVED or DECLINED", "required": true, "schema": { "type": "string", "enum": [ "APPROVED", "DECLINED" ] } }, { "name": "comment", "in": "query", "description": "Optional decision comment", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Approve or decline a membership pause", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MembershipPauseRequest" } } } } } }, "patch": { "tags": [ "CRM \/ MembershipPauseRequest" ], "summary": "Approve (writes the pause into the membership) or decline a membership pause", "operationId": "patch_put_membership_pause_request_decide", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "decision", "in": "query", "description": "APPROVED or DECLINED", "required": true, "schema": { "type": "string", "enum": [ "APPROVED", "DECLINED" ] } }, { "name": "comment", "in": "query", "description": "Optional decision comment", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Approve or decline a membership pause", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MembershipPauseRequest" } } } } } } }, "\/api\/crm\/membership_pause_request\/{id}": { "get": { "tags": [ "CRM \/ MembershipPauseRequest" ], "summary": "Get a single membership pause", "operationId": "get_get_membership_pause_request", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MembershipPauseRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MembershipPauseRequest" } } } } } } }, "\/api\/crm\/membership_pause_request": { "get": { "tags": [ "CRM \/ MembershipPauseRequest" ], "summary": "List membership pauses (filter status=REQUESTED for the open ones)", "operationId": "get_get_membership_pause_requests", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "logBookEntry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "First day of the pause. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "description": "Last day of the pause (the whole day is included). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MembershipPauseRequest objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MembershipPauseRequest" } } } } } } } }, "\/api\/crm\/person_log_book_entry_type": { "get": { "tags": [ "CRM \/ PersonLogBookEntryType" ], "summary": "This method will get all PersonLogBookEntryType Objects", "operationId": "get_crm_person_log_book_entry_type_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/crm\/person_log_book_entry_content_addition": { "get": { "tags": [ "CRM \/ PersonLogBookEntryContentAddition" ], "summary": "This method will get all PersonLogBookEntryContentAddition Objects", "operationId": "get_crm_person_log_book_entry_content_addition_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/crm\/crmcompanies": { "get": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Returns a list of billing accounts \/ companies", "operationId": "get_get_crmcompanies", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "companyName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "archived", "in": "query", "description": "Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "isCustomer", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "isSupplier", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "isOther", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "paymentGoal", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "paymentType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "paymentInterval", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "visibleForCustomer", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "internalContact", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "number", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "billReminderCount", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bankDisabled", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "billReminderDisabled", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "disabledEbStart", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "disabledEbEnd", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bankMaxValuePerMonth", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "paymentMandateSignDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "paymentMandateValidUntilDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "foundingDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "linkingIdentifier", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "naceSection", "in": "query", "description": "NACE section code (letter A-U) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "naceCode", "in": "query", "description": "NACE code (numeric like 01.11, 62.01) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreet", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressHouseNumber", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreetLevel", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCo", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCity", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressZip", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressAdminLevel1", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCountry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressFullCountry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLat", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLng", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressExternalProviderId", "in": "query", "description": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of accounts \/ companies", "content": { "application\/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMCompany" } } ] } } } } } }, "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Creates a single account \/ CRMCompany", "operationId": "post_post_crmcompany", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "crmcompany": { "$ref": "#\/components\/schemas\/CRMCompany2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single account \/ CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany3" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}": { "get": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Returns a single account \/ CRMCompany", "operationId": "get_get_crmcompany", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single account \/ CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany3" } } } } } }, "put": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Updates a single account \/ CRMCompany with the given identifier", "operationId": "put_put_crmcompany", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "crmcompany": { "$ref": "#\/components\/schemas\/CRMCompany2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single account \/ CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany3" } } } } } }, "patch": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Updates a single account \/ CRMCompany with the given identifier", "operationId": "patch_put_crmcompany", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "crmcompany": { "$ref": "#\/components\/schemas\/CRMCompany2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single account \/ CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany3" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}\/adds\/people": { "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Add a CRMPerson to a CRMCompany", "operationId": "post_post_crmcompany_add_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add a CRMPerson to a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany4" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}\/gdpr_erasure": { "get": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Preview of a GDPR (DSGVO Art. 17) erasure of the account and of its persons that\nbelong to no other account: what blocks it and which data would be deleted,\nanonymized or retained because of statutory retention periods.", "operationId": "get_get_crmcompany_gdpr_erasure", "parameters": [ { "name": "deleteAttachments", "in": "query", "description": "Also delete the documents attached to the account", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns blockers, affected persons and the affected data (items) of a GDPR erasure" } } }, "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Executes the GDPR (DSGVO Art. 17) erasure of the account and of its persons that\nbelong to no other account. Invoices, offers and payment transactions are retained\n(statutory retention), everything else is anonymized or deleted. Not reversible.", "operationId": "post_post_crmcompany_gdpr_erasure", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "required": [ "confirm" ], "properties": { "confirm": { "description": "Must be true, the erasure can not be undone", "type": "boolean" }, "deleteAttachments": { "description": "Also delete the documents attached to the account", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns what was deleted, anonymized and retained" } } } }, "\/api\/crm\/crmcompanies\/{id}\/deletes\/people": { "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Delete a CRMPerson from a CRMCompany", "operationId": "post_post_crmcompany_delete_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a CRMPerson from a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany4" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}\/adds\/internalcontacts": { "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Add an Internal Contact to a CRMCompany", "operationId": "post_post_crmcompany_add_internalcontact", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add an Internal Contact to a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany4" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}\/deletes\/internalcontacts": { "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Delete an Internal Contact from a CRMCompany", "operationId": "post_post_crmcompany_delete_internalcontact", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete an Internal Contact from a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany4" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}\/adds\/managingdirectors": { "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Add a Managing Director to a CRMCompany", "operationId": "post_post_crmcompany_add_managingdirector", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add a Managing Director to a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany4" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}\/deletes\/managingdirectors": { "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Delete a Managing Director from a CRMCompany", "operationId": "post_post_crmcompany_delete_managingdirector", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a Managing Director from a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany4" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}\/adds\/maincontacts": { "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Add a Main Contact to a CRMCompany", "operationId": "post_post_crmcompany_add_maincontact", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add a Main Contact to a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany4" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}\/deletes\/maincontacts": { "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Delete a Main Contact from a CRMCompany", "operationId": "post_post_crmcompany_delete_maincontact", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a Main Contact from a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany4" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}\/adds\/departments": { "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Add a CRMDepartment to a CRMCompany", "operationId": "post_post_crmcompany_add_department", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add a CRMDepartment to a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany4" } } } } } } }, "\/api\/crm\/crmcompanies\/{id}\/deletes\/departments": { "post": { "tags": [ "CRM \/ Accounts | Companies" ], "summary": "Delete a CRMDepartment from a CRMCompany", "operationId": "post_post_crmcompany_delete_department", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a CRMDepartment from a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany4" } } } } } } }, "\/api\/crm\/crmdepartments": { "get": { "tags": [ "CRM \/ CRMDepartment" ], "summary": "This method will get all CRMDepartment Objects", "operationId": "get_get_crmdepartments", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "externalDescription", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "internalDescription", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreet", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressHouseNumber", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreetLevel", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCo", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCity", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressZip", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressAdminLevel1", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCountry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressFullCountry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLat", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLng", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CRMDepartment objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMDepartment" } } } } } } }, "post": { "tags": [ "CRM \/ CRMDepartment" ], "summary": "Add a new CRMDepartment", "operationId": "post_post_crmdepartment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new CRMDepartment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMDepartment" } } } } } } }, "\/api\/crm\/crmdepartments\/{id}": { "get": { "tags": [ "CRM \/ CRMDepartment" ], "summary": "This method will get a single CRMDepartment Object with the given id", "operationId": "get_get_crmdepartment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single CRMDepartment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMDepartment" } } } } } }, "put": { "tags": [ "CRM \/ CRMDepartment" ], "summary": "This method will update a CRMDepartment Object", "operationId": "put_put_crmdepartment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a CRMDepartment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMDepartment" } } } } } }, "patch": { "tags": [ "CRM \/ CRMDepartment" ], "summary": "This method will update a CRMDepartment Object", "operationId": "patch_put_crmdepartment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a CRMDepartment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMDepartment" } } } } } } }, "\/api\/crm\/crmdepartments\/{id}\/adds\/people": { "post": { "tags": [ "CRM \/ CRMDepartment" ], "summary": "Add a CRMPerson to a CRMDepartment", "operationId": "post_post_crmdepartment_add_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add a CRMPerson to a CRMDepartment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMDepartment" } } } } } } }, "\/api\/crm\/crmdepartments\/{id}\/deletes\/people": { "post": { "tags": [ "CRM \/ CRMDepartment" ], "summary": "Delete a CRMPerson from a CRMDepartment", "operationId": "post_post_crmdepartment_delete_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a CRMPerson from a CRMDepartment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMDepartment" } } } } } } }, "\/api\/crm\/crmpeople": { "get": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Returns a list of people", "operationId": "get_get_crmpeople", "parameters": [ { "name": "archived", "in": "query", "description": "Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "hasLoginUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "subscribedNewsletter", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "subscribedMagazine", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookStaff", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookStaff1", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookStaff2", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookMember", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookTrainer", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookTrainer1", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookTrainer2", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookHeadOfDepartment", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookSupervisoryBoard", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookBoardOfDirectors", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookHonoraryMember", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookClubCardOne", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookHealthRecovered", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookHealthVaccinated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookHealthVaccinatedAddition", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "logBookGoodConduct", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookFirstAid", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookMeaslesVaccination", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "birthday", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "formOfSalutation", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "specialSalutation", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "position", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "numberString", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "manualNumber", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "number", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "importOriginId", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bitmaskLogBookContentType", "in": "query", "description": "This is a bitmask value of the different log book content types | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "confirmedNoAllergies", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "knownAllergies", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "allowPhotos", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "allowLeavingAlone", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "authorizedPickup", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "needsSupport", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "supportDescription", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "financialSupport", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "financialSupportNumber", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "municipalSupport", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "municipalSupportNumber", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "gradeLevel", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "schoolClass", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "linkingIdentifier", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreet", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressHouseNumber", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreetLevel", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCo", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCity", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressZip", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressAdminLevel1", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCountry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressFullCountry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLat", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLng", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressExternalProviderId", "in": "query", "description": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "aiChurnRiskScore", "in": "query", "description": "K\u00fcndigungsrisiko 0-100 aus der KI-Bewertung (MemberChurnRiskHelper); nur f\u00fcr das Team. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of people", "content": { "application\/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson" } }, { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson2" } } ] } } } } } }, "post": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Add a new person", "operationId": "post_post_crmperson", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "crmperson": { "$ref": "#\/components\/schemas\/CRMPerson3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new person", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPerson10" } } } } } } }, "\/api\/crm\/crmpeople\/{id}": { "get": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Return a single person with the given id", "operationId": "get_get_crmperson", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a single person with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPerson10" } } } } } }, "put": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Updates a single person with the given identifier", "operationId": "put_put_crmperson", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "crmperson": { "$ref": "#\/components\/schemas\/CRMPerson3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single person with the given identifier", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPerson10" } } } } } }, "patch": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Updates a single person with the given identifier", "operationId": "patch_put_crmperson", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "crmperson": { "$ref": "#\/components\/schemas\/CRMPerson3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single person with the given identifier", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPerson10" } } } } } } }, "\/api\/crm\/crmpeople\/{id}\/archive_account": { "post": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Archives the complete school account when the selected person is its only active child.", "operationId": "post_post_crmperson_archive_account", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "required": [ "companyId" ], "properties": { "companyId": { "description": "CRMCompany id or identifier", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns the archived account and person ids" } } } }, "\/api\/crm\/crmpeople\/{id}\/own_company": { "post": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Creates an own account (billing account) for a person without one and links the person: name,\naddress and e-mail of the person, default payment settings, no product. For staff and trainers\nthat were created as plain persons.", "operationId": "post_post_crmperson_own_company", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the new account" } } } }, "\/api\/crm\/crmpeople\/{id}\/archive_account_candidates": { "get": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Returns active school accounts for which the selected person is the only active child.", "operationId": "get_get_crmperson_archive_account_candidates", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns eligible account ids and names" } } } }, "\/api\/crm\/crmpeople\/{id}\/merge": { "post": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Merge one or more persons into the given main person.", "description": "Migrates tickets (all), questionnaire answers, event sign ups, individual bookings\nand log book entries (memberships \/ functions \/ roles) from the source persons onto\nthe main person (the latter four with duplicate checks) and archives the migrated\nsource persons. Each migrated record's company is kept when the main person already\nbelongs to it; otherwise it is replaced with the main person's primary company.\nIn SCHOOL mode every source person has to share a school (unified category of a log book\nentry) with the main person, otherwise the request is rejected with a 400.\n\nRequest body:\n - ids (int[]): ids of the persons that should be merged into the main person\n - includeContactData (bool, optional): migrate emails \/ phone numbers from source persons\n - copyScalarFields (bool, optional): copy personal-data scalar fields (birthday, gender,\n address, school data, ...) from source persons when the main person's field is empty", "operationId": "post_post_crmperson_merge", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "ids": { "description": "Ids of the persons that should be merged into the main person", "type": "array", "items": { "type": "integer" } }, "includeContactData": { "description": "Migrate contact data (emails \/ phone numbers) from source persons", "type": "boolean" }, "copyScalarFields": { "description": "Copy personal-data scalar fields from source persons when the main person's field is empty", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns the merge result statistics" } } } }, "\/api\/crm\/crmpeople\/{id}\/gdpr_erasure": { "get": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Preview of a GDPR (DSGVO Art. 17) erasure of the person: what blocks it and which data\nwould be deleted, anonymized or retained because of statutory retention periods.", "operationId": "get_get_crmperson_gdpr_erasure", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns blockers and the affected data (items) of a GDPR erasure" } } }, "post": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Executes the GDPR (DSGVO Art. 17) erasure of the person. The person is anonymized and\narchived, its personal data (contact data, login, attachments, communication, copies\nin sign ups \/ bookings \/ tickets, audit history) is deleted. Accounting documents\nare retained. Not reversible.", "operationId": "post_post_crmperson_gdpr_erasure", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "required": [ "confirm" ], "properties": { "confirm": { "description": "Must be true, the erasure can not be undone", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns what was deleted, anonymized and retained" } } } }, "\/api\/crm\/crmpeople\/duplicates": { "get": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Returns the list of duplicated persons grouped by name and birthday.", "description": "Each group contains the suggested merge target (the person with an active login\nuser \/ customer portal access, otherwise the person with the latest activity)\nand per person context information (linked companies, active event sign ups and\nactive memberships \/ functions \/ roles).", "operationId": "get_get_crmperson_duplicates", "parameters": [ { "name": "includeArchived", "in": "query", "description": "Include archived persons in the duplicate detection | Default value: true", "required": false, "schema": { "type": "boolean" } }, { "name": "schoolMode", "in": "query", "description": "Override the school mode derived from the inwendo_short_info_mode setting", "required": false, "schema": { "type": "boolean" } }, { "name": "unifiedCategoryId", "in": "query", "description": "Limit the duplicate detection to a single unified category (school mode)", "required": false, "schema": { "type": "integer" } }, { "name": "ucats", "in": "query", "description": "Fallback for unifiedCategoryId, accepts the person list's comma separated category filter", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the list of duplicated person groups" } } } }, "\/api\/crm\/crmpeople\/{id}\/access_tags": { "get": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Returns the currently available AccessTags for a person grouped by company.", "description": "Next to the effective AccessTags the response contains the origin of every single tag\n(company, subscription, log book entry \/ role or temporary access), which makes it\npossible to answer \"why does this person have this access right?\".", "operationId": "get_get_crmperson_access_tags", "parameters": [ { "name": "companyId", "in": "query", "description": "Optional CRMCompany id or short identifier to limit the calculation to one of the companies of the person", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the available AccessTags for the person" } } } }, "\/api\/crm\/action\/grade_level_update": { "post": { "tags": [ "CRM \/ Actions" ], "summary": "Update grade levels for persons matching filters", "operationId": "post_crm_grade_level_update_post", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/GradeLevelUpdateRequest" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns update result summary", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GradeLevelUpdateRequest2" } } } } } } }, "\/api\/crm\/crmpersoncontactdatas": { "get": { "tags": [ "CRM \/ CRMPersonContactData" ], "summary": "This method will get all CRMPersonContactData Objects", "operationId": "get_get_crmpersoncontactdatas", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "label", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CRMPersonContactData objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } } } } } } }, "post": { "tags": [ "CRM \/ CRMPersonContactData" ], "summary": "Add a new CRMPersonContactData", "operationId": "post_post_crmpersoncontactdata", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new CRMPersonContactData", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPersonContactData2" } } } } } } }, "\/api\/crm\/crmpersoncontactdatas\/{id}": { "get": { "tags": [ "CRM \/ CRMPersonContactData" ], "summary": "This method will get a single CRMPersonContactData Object with the given id", "operationId": "get_get_crmpersoncontactdata", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single CRMPersonContactData", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPersonContactData2" } } } } } }, "put": { "tags": [ "CRM \/ CRMPersonContactData" ], "summary": "This method will update a CRMPersonContactData Object", "operationId": "put_put_crmpersoncontactdata", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a CRMPersonContactData", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPersonContactData2" } } } } } }, "delete": { "tags": [ "CRM \/ CRMPersonContactData" ], "summary": "This method will delete a single CRMPersonContactData Object with the given id", "operationId": "delete_delete_crmpersoncontactdata", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a CRMPersonContactData", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPersonContactData2" } } } } } }, "patch": { "tags": [ "CRM \/ CRMPersonContactData" ], "summary": "This method will update a CRMPersonContactData Object", "operationId": "patch_put_crmpersoncontactdata", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a CRMPersonContactData", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPersonContactData2" } } } } } } }, "\/api\/crm\/person_duration_honors": { "get": { "tags": [ "CRM \/ PersonDurationStatistic" ], "summary": "Find persons matching one or several duration criteria for honors.", "operationId": "get_crm_person_duration_honors", "parameters": [ { "name": "archived", "in": "query", "description": "Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "hasLoginUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "subscribedNewsletter", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "subscribedMagazine", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookStaff", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookStaff1", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookStaff2", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookMember", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookTrainer", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookTrainer1", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookTrainer2", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookHeadOfDepartment", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookSupervisoryBoard", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookBoardOfDirectors", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookHonoraryMember", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookClubCardOne", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookHealthRecovered", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookHealthVaccinated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookHealthVaccinatedAddition", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "logBookGoodConduct", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookFirstAid", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "logBookMeaslesVaccination", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "birthday", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "formOfSalutation", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "specialSalutation", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "position", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "numberString", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "manualNumber", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "number", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "importOriginId", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bitmaskLogBookContentType", "in": "query", "description": "This is a bitmask value of the different log book content types | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "confirmedNoAllergies", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "knownAllergies", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "allowPhotos", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "allowLeavingAlone", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "authorizedPickup", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "needsSupport", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "supportDescription", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "financialSupport", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "financialSupportNumber", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "municipalSupport", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "municipalSupportNumber", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "gradeLevel", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "schoolClass", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "linkingIdentifier", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreet", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressHouseNumber", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreetLevel", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCo", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCity", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressZip", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressAdminLevel1", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCountry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressFullCountry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLat", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLng", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressExternalProviderId", "in": "query", "description": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "aiChurnRiskScore", "in": "query", "description": "K\u00fcndigungsrisiko 0-100 aus der KI-Bewertung (MemberChurnRiskHelper); nur f\u00fcr das Team. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Persons eligible for honors", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson2" } } } } } } } }, "\/api\/crm\/general_meeting\/own": { "get": { "tags": [ "CRM \/ General meeting (own)" ], "summary": "The own meetings (not drafts), newest first.", "operationId": "get_crm_general_meeting_own_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of meetings with the own participation" } } } }, "\/api\/crm\/general_meeting\/own\/{id}": { "get": { "tags": [ "CRM \/ General meeting (own)" ], "summary": "One own meeting with motions, the own ballots and, once closed, results and minutes.", "operationId": "get_crm_general_meeting_own_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "The meeting with participation, motions and minutes" } } } }, "\/api\/crm\/general_meeting\/own\/{id}\/respond": { "post": { "tags": [ "CRM \/ General meeting (own)" ], "summary": "Accept or decline the invitation.", "operationId": "post_crm_general_meeting_own_respond", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "response": { "description": "ACCEPTED, DECLINED", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The meeting with participation" } } } }, "\/api\/crm\/general_meeting\/own\/{id}\/check_in": { "post": { "tags": [ "CRM \/ General meeting (own)" ], "summary": "Take part online: counts as present (online) for quorum and votes.", "operationId": "post_crm_general_meeting_own_check_in", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "The meeting with participation" } } } }, "\/api\/crm\/general_meeting\/own\/motion\/{id}\/vote": { "post": { "tags": [ "CRM \/ General meeting (own)" ], "summary": "Vote on an open motion: YES, NO or ABSTAIN. One vote per person and motion.", "operationId": "post_crm_general_meeting_own_vote", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "choice": { "description": "YES, NO, ABSTAIN", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The meeting with participation and motions" } } } }, "\/api\/crm\/general_meeting": { "get": { "tags": [ "CRM \/ General meeting" ], "summary": "All general meetings, newest start first.", "operationId": "get_crm_general_meeting_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "meetingType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "invitedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of GeneralMeeting objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/GeneralMeeting" } } } } } } }, "post": { "tags": [ "CRM \/ General meeting" ], "summary": "Creates a new crm general meeting entry.", "operationId": "post_crm_general_meeting_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "name": { "type": "string" }, "agenda": { "type": "string" }, "meeting_type": { "description": "PRESENCE, ONLINE, HYBRID", "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "location": { "type": "string" }, "online_url": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The new GeneralMeeting", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeeting" } } } } } } }, "\/api\/crm\/general_meeting\/{id}": { "get": { "tags": [ "CRM \/ General meeting" ], "summary": "Returns a single crm general meeting entry.", "operationId": "get_crm_general_meeting_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns a single GeneralMeeting with statistics", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeeting" } } } } } }, "put": { "tags": [ "CRM \/ General meeting" ], "summary": "Meeting data while open; the minutes until they are finalized.", "operationId": "put_crm_general_meeting_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "name": { "type": "string" }, "agenda": { "type": "string" }, "meeting_type": { "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "location": { "type": "string" }, "online_url": { "type": "string" }, "minutes": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The changed GeneralMeeting", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeeting" } } } } } }, "delete": { "tags": [ "CRM \/ General meeting" ], "summary": "Marks the meeting as deleted. A running meeting has to be closed or cancelled first.", "operationId": "delete_crm_general_meeting_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "The deleted GeneralMeeting" } } }, "patch": { "tags": [ "CRM \/ General meeting" ], "summary": "Meeting data while open; the minutes until they are finalized.", "operationId": "patch_crm_general_meeting_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "name": { "type": "string" }, "agenda": { "type": "string" }, "meeting_type": { "type": "string" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "location": { "type": "string" }, "online_url": { "type": "string" }, "minutes": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The changed GeneralMeeting", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeeting" } } } } } } }, "\/api\/crm\/general_meeting\/{id}\/{action}": { "post": { "tags": [ "CRM \/ General meeting" ], "summary": "invite (body force=true confirms an invitation after the notice period), start, close,\ncancel, generate_participants (members on the meeting day), generate_minutes, finalize_minutes.", "operationId": "post_crm_general_meeting_action", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "action", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "force": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "meeting (GeneralMeeting) and result (counts of the action)" } } } }, "\/api\/crm\/general_meeting_participant": { "get": { "tags": [ "CRM \/ General meeting" ], "summary": "Participants of a meeting (meeting=), by name.", "operationId": "get_crm_general_meeting_participant_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "meeting", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "votingRight", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "votingRightReason", "in": "query", "description": "NO_VOTE_* when the person has no voting right, null otherwise. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "votingRightManual", "in": "query", "description": "The office set the voting right by hand; a recalculation keeps it. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "response", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "attendance", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "invitedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of GeneralMeetingParticipant objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/GeneralMeetingParticipant" } } } } } } }, "post": { "tags": [ "CRM \/ General meeting" ], "summary": "Adds one person; without voting_right it is calculated from the settings.", "operationId": "post_crm_general_meeting_participant_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "meeting": { "type": "integer" }, "person": { "type": "integer" }, "voting_right": { "type": "boolean", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "The participant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeetingParticipant" } } } } } } }, "\/api\/crm\/general_meeting_participant\/{id}": { "put": { "tags": [ "CRM \/ General meeting" ], "summary": "voting_right (true\/false by hand, null = calculated again), attendance (ABSENT, ONSITE, ONLINE), response.", "operationId": "put_crm_general_meeting_participant_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "voting_right": { "type": "boolean", "nullable": true }, "attendance": { "type": "string" }, "response": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The participant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeetingParticipant" } } } } } }, "delete": { "tags": [ "CRM \/ General meeting" ], "summary": "Removes a participant.", "operationId": "delete_crm_general_meeting_participant_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "removed" } } }, "patch": { "tags": [ "CRM \/ General meeting" ], "summary": "voting_right (true\/false by hand, null = calculated again), attendance (ABSENT, ONSITE, ONLINE), response.", "operationId": "patch_crm_general_meeting_participant_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "voting_right": { "type": "boolean", "nullable": true }, "attendance": { "type": "string" }, "response": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The participant", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeetingParticipant" } } } } } } }, "\/api\/crm\/general_meeting_motion": { "get": { "tags": [ "CRM \/ General meeting" ], "summary": "Motions of a meeting (meeting=), by position.", "operationId": "get_crm_general_meeting_motion_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "meeting", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "votingMode", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "majority", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "result", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "position", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of GeneralMeetingMotion objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/GeneralMeetingMotion" } } } } } } }, "post": { "tags": [ "CRM \/ General meeting" ], "summary": "Creates a motion.", "operationId": "post_crm_general_meeting_motion_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "meeting": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "voting_mode": { "description": "OPEN, SECRET", "type": "string" }, "majority": { "description": "SIMPLE, TWO_THIRDS, THREE_QUARTERS, ABSOLUTE", "type": "string" }, "position": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "The new motion", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeetingMotion" } } } } } } }, "\/api\/crm\/general_meeting_motion\/{id}": { "get": { "tags": [ "CRM \/ General meeting" ], "summary": "Returns a motion.", "operationId": "get_crm_general_meeting_motion_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns a single GeneralMeetingMotion", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeetingMotion" } } } } } }, "put": { "tags": [ "CRM \/ General meeting" ], "summary": "Updates a motion.", "operationId": "put_crm_general_meeting_motion_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "voting_mode": { "type": "string" }, "majority": { "type": "string" }, "position": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "The changed motion", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeetingMotion" } } } } } }, "delete": { "tags": [ "CRM \/ General meeting" ], "summary": "Deletes a motion.", "operationId": "delete_crm_general_meeting_motion_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "The deleted motion" } } }, "patch": { "tags": [ "CRM \/ General meeting" ], "summary": "Updates a motion.", "operationId": "patch_crm_general_meeting_motion_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "voting_mode": { "type": "string" }, "majority": { "type": "string" }, "position": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "The changed motion", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeetingMotion" } } } } } } }, "\/api\/crm\/general_meeting_motion\/{id}\/votes": { "get": { "tags": [ "CRM \/ General meeting" ], "summary": "The votes by name of an open (not secret) motion; a secret motion answers an empty list.", "operationId": "get_crm_general_meeting_motion_votes", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "List of {choice, person_minimal}" } } } }, "\/api\/crm\/general_meeting_motion\/{id}\/{action}": { "post": { "tags": [ "CRM \/ General meeting" ], "summary": "open (start the vote; the meeting has to run), close (body manual_yes, manual_no,\nmanual_abstain: votes counted on site, added to the app votes).", "operationId": "post_crm_general_meeting_motion_action", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "action", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "manual_yes": { "type": "integer" }, "manual_no": { "type": "integer" }, "manual_abstain": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "The motion after the action", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/GeneralMeetingMotion" } } } } } } }, "\/api\/crm\/crmpersondurationstatistics\/{identifier}": { "get": { "tags": [ "CRM \/ PersonDurationStatistic" ], "summary": "Get a single CRMPersonDurationStatistic by ID", "operationId": "get_get_crmpersondurationstatistic", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single CRMPersonDurationStatistic", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPersonDurationStatistic" } } } } } } }, "\/api\/crm\/crmpersondurationstatistics": { "get": { "tags": [ "CRM \/ PersonDurationStatistic" ], "summary": "Returns a list of CRMPersonDurationStatistic", "operationId": "get_get_crmpersondurationstatistics", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CRMPersonDurationStatistic", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonDurationStatistic" } } } } } } } }, "\/api\/crm\/person_honor_anniversaries": { "get": { "tags": [ "CRM \/ PersonHonorAnniversary" ], "summary": "Returns a list of CRMPersonHonorAnniversary, by default the earliest anniversary first", "operationId": "get_crm_person_honor_anniversary_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "LOG_CONTENT_TYPE_MEMBER or CRMPersonDurationStatistic::CONTENT_TYPE_VOLUNTEER | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "basis", "in": "query", "description": "BASIS_TOTAL or BASIS_CURRENT | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "years", "in": "query", "description": "The anniversary in years (10, 25, 40 ...) | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "dueDate", "in": "query", "description": "Day the anniversary is reached, estimated from the monthly counter (first day of that month) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reminderSent", "in": "query", "description": "When the office reminder listing this anniversary was sent | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "greetingSent", "in": "query", "description": "When the congratulation with certificate was sent to the person | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "handled", "in": "query", "description": "When the honor was marked as done (certificate handed over); NULL = still open | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CRMPersonHonorAnniversary", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonHonorAnniversary" } } } } } } } }, "\/api\/crm\/person_honor_anniversaries\/{identifier}": { "get": { "tags": [ "CRM \/ PersonHonorAnniversary" ], "summary": "Get a single CRMPersonHonorAnniversary by ID", "operationId": "get_crm_person_honor_anniversary_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns a single CRMPersonHonorAnniversary", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPersonHonorAnniversary" } } } } } } }, "\/api\/crm\/person_honor_anniversaries\/{identifier}\/handled": { "put": { "tags": [ "CRM \/ PersonHonorAnniversary" ], "summary": "Mark an anniversary as handed over (handled=1, the default) or open it again (handled=0)", "operationId": "put_crm_person_honor_anniversary_handled", "parameters": [ { "name": "handled", "in": "query", "description": "1 = handed over, 0 = open again | Default value: 1", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "The updated CRMPersonHonorAnniversary", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPersonHonorAnniversary" } } } } } }, "post": { "tags": [ "CRM \/ PersonHonorAnniversary" ], "summary": "Mark an anniversary as handed over (handled=1, the default) or open it again (handled=0)", "operationId": "post_crm_person_honor_anniversary_handled", "parameters": [ { "name": "handled", "in": "query", "description": "1 = handed over, 0 = open again | Default value: 1", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "The updated CRMPersonHonorAnniversary", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMPersonHonorAnniversary" } } } } } } }, "\/api\/crm\/person_honor_anniversaries\/{identifier}\/certificate": { "get": { "tags": [ "CRM \/ PersonHonorAnniversary" ], "summary": "The certificate (Urkunde) of an anniversary as PDF, rendered with the template configured for its type", "operationId": "get_crm_person_honor_anniversary_certificate", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "PDF of the certificate", "content": { "application\/pdf": [] } } } }, "post": { "tags": [ "CRM \/ PersonHonorAnniversary" ], "summary": "The certificate (Urkunde) of an anniversary as PDF, rendered with the template configured for its type", "operationId": "post_crm_person_honor_anniversary_certificate", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "PDF of the certificate", "content": { "application\/pdf": [] } } } } }, "\/api\/crm\/person_send_notification": { "get": { "tags": [ "CRM \/ PersonSendNotification" ], "summary": "Returns a list of CrmPersonSendNotification", "operationId": "get_crm_person_send_notification_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "membershipEntryNotificationSent", "in": "query", "description": "When the membership entry notification (Eintritt) was last sent | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "membershipExitNotificationSent", "in": "query", "description": "When the membership exit notification (Austritt) was last sent | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "birthdayGreetingSent", "in": "query", "description": "When the birthday greeting was last sent | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CrmPersonSendNotification", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CrmPersonSendNotification" } } } } } } } }, "\/api\/crm\/person_send_notification\/{identifier}": { "get": { "tags": [ "CRM \/ PersonSendNotification" ], "summary": "Get a single CrmPersonSendNotification by ID", "operationId": "get_crm_person_send_notification_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single CrmPersonSendNotification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CrmPersonSendNotification2" } } } } } }, "put": { "tags": [ "CRM \/ PersonSendNotification" ], "summary": "Update a CrmPersonSendNotification - clear a send marker by setting it to null to allow sending again", "operationId": "put_crm_person_send_notification_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CrmPersonSendNotification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a CrmPersonSendNotification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CrmPersonSendNotification2" } } } } } }, "delete": { "tags": [ "CRM \/ PersonSendNotification" ], "summary": "Delete a single CrmPersonSendNotification with the given id - clears all send markers of the person", "operationId": "delete_crm_person_send_notification_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single CrmPersonSendNotification with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CrmPersonSendNotification2" } } } } } }, "patch": { "tags": [ "CRM \/ PersonSendNotification" ], "summary": "Update a CrmPersonSendNotification - clear a send marker by setting it to null to allow sending again", "operationId": "patch_crm_person_send_notification_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CrmPersonSendNotification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a CrmPersonSendNotification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CrmPersonSendNotification2" } } } } } } }, "\/api\/crm\/crmprojects": { "get": { "tags": [ "CRM \/ CRMProject" ], "summary": "This method will get all CRMProject Objects", "operationId": "get_get_crmprojects", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CRMProject objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMProject" } } } } } } }, "post": { "tags": [ "CRM \/ CRMProject" ], "summary": "Add a new CRMProject", "operationId": "post_post_crmproject", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProject2" } } } } } } }, "\/api\/crm\/crmprojects\/{id}": { "put": { "tags": [ "CRM \/ CRMProject" ], "summary": "This method will update a CRMProject Object", "operationId": "put_put_crmproject", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProject2" } } } } } }, "patch": { "tags": [ "CRM \/ CRMProject" ], "summary": "This method will update a CRMProject Object", "operationId": "patch_put_crmproject", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProject2" } } } } } } }, "\/api\/crm\/crmprojects\/{identifier}": { "get": { "tags": [ "CRM \/ CRMProject" ], "summary": "This method will get a single CRMProject Object with the given id", "operationId": "get_get_crmproject", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProject2" } } } } } } }, "\/api\/crm\/crmprojects\/{projectIdentifier}\/offers": { "get": { "tags": [ "CRM \/ CRMProject" ], "summary": "This method will get all used offers in the given project", "operationId": "get_get_crmproject_offers", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "projectIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of Offers for a CRMProject", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Offer" } } } } } } } }, "\/api\/crm\/crmprojects\/{projectIdentifier}\/time\/report": { "get": { "tags": [ "CRM \/ CRMProject" ], "summary": "This method will get a time report of the given project", "operationId": "get_get_crmproject_time_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "projectIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a time report for a CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProjectTimeReport" } } } } } } }, "\/api\/crm\/crmprojects\/{id}\/adds\/internalcontacts": { "post": { "tags": [ "CRM \/ CRMProject" ], "summary": "Add an Internal Contact to a CRMProject", "operationId": "post_post_crmproject_add_internalcontact", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add an Internal Contact to a CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProject2" } } } } } } }, "\/api\/crm\/crmprojects\/{id}\/deletes\/internalcontacts": { "post": { "tags": [ "CRM \/ CRMProject" ], "summary": "Delete an Internal Contact from a CRMProject", "operationId": "post_post_crmproject_delete_internalcontact", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete an Internal Contact from a CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProject2" } } } } } } }, "\/api\/crm\/crmprojects\/{id}\/adds\/maincontacts": { "post": { "tags": [ "CRM \/ CRMProject" ], "summary": "Add Main Contacts to a CRMProject", "operationId": "post_post_crmproject_add_maincontact", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add Main Contacts to a CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProject2" } } } } } } }, "\/api\/crm\/crmprojects\/{id}\/deletes\/maincontacts": { "post": { "tags": [ "CRM \/ CRMProject" ], "summary": "Delete Main Contacts from a CRMProject", "operationId": "post_post_crmproject_delete_maincontact", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete Main Contacts from a CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProject2" } } } } } } }, "\/api\/crm\/crmprojects\/{id}\/adds\/employees": { "post": { "tags": [ "CRM \/ CRMProject" ], "summary": "Add a Employee to a CRMProject", "operationId": "post_post_crmproject_add_employee", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add an Employee to a CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProject2" } } } } } } }, "\/api\/crm\/crmprojects\/{id}\/deletes\/employees": { "post": { "tags": [ "CRM \/ CRMProject" ], "summary": "Delete a Employee from a CRMProject", "operationId": "post_post_crmproject_delete_employee", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete an Employee from a CRMProject", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProject2" } } } } } } }, "\/api\/crm\/crmprojectitems": { "get": { "tags": [ "CRM \/ CRMProjectItem" ], "summary": "This method will get all CRMProjectItem Objects", "operationId": "get_get_crmprojectitems", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CRMProjectItem objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMProjectItem" } } } } } } }, "post": { "tags": [ "CRM \/ CRMProjectItem" ], "summary": "Add a new CRMProjectItem", "operationId": "post_post_crmprojectitem", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new CRMProjectItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProjectItem2" } } } } } } }, "\/api\/crm\/crmprojectitems\/{id}": { "get": { "tags": [ "CRM \/ CRMProjectItem" ], "summary": "This method will get a single CRMProjectItem Object with the given id", "operationId": "get_get_crmprojectitem", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single CRMProjectItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProjectItem" } } } } } }, "put": { "tags": [ "CRM \/ CRMProjectItem" ], "summary": "This method will update a CRMProjectItem Object", "operationId": "put_put_crmprojectitem", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a CRMProjectItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProjectItem" } } } } } }, "patch": { "tags": [ "CRM \/ CRMProjectItem" ], "summary": "This method will update a CRMProjectItem Object", "operationId": "patch_put_crmprojectitem", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a CRMProjectItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMProjectItem" } } } } } } }, "\/api\/crm\/crmrecurrences": { "get": { "tags": [ "CRM \/ CRMRecurrence" ], "summary": "This method will get all CRMRecurrence Objects", "operationId": "get_get_crmrecurrences", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "recurrenceType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "recurrenceInterval", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "recurrenceWeekday", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "recurrenceMonthday", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "recurrenceStartDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "recurrenceEndDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "nextOccurrence", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "lastOccurrence", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CRMRecurrence objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMRecurrence" } } } } } } } }, "\/api\/crm\/crmprojectcategories": { "get": { "tags": [ "CRM \/ CRMProjectCategory" ], "summary": "This method will get all CRMProjectCategory Objects", "operationId": "get_get_crmprojectcategories", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "externalDescription", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "internalDescription", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CRMProjectCategory objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMProjectCategory" } } } } } } } }, "\/api\/crm\/crmcompanycategory": { "get": { "tags": [ "CRM \/ CRMCompanyCategory" ], "summary": "This method will get all CRMCompanyCategory Objects", "operationId": "get_crm_company_category_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "externalDescription", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "internalDescription", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CRMCompanyCategory objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } } } } } } } }, "\/api\/crm\/crmpersoncategory": { "get": { "tags": [ "CRM \/ CRMPersonCategory" ], "summary": "This method will get all CRMPersonCategory Objects", "operationId": "get_crm_person_category_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/crm\/messages\/{companyId}": { "post": { "tags": [ "CRM \/ CrmMessage" ], "summary": "Add a new CustomerMessage for a company", "operationId": "post_post_crm_message", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add a new CustomerMessage for a company", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerMessage" } } } } } } }, "\/api\/crm\/messages\/{id}": { "get": { "tags": [ "CRM \/ CrmMessage" ], "summary": "This method will get a single CustomerMessage Object with the given id", "operationId": "get_get_crm_message", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single CustomerMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerMessage" } } } } } }, "put": { "tags": [ "CRM \/ CrmMessage" ], "summary": "This method will update a CustomerMessage Object", "operationId": "put_put_crm_message", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a CustomerMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerMessage" } } } } } }, "patch": { "tags": [ "CRM \/ CrmMessage" ], "summary": "This method will update a CustomerMessage Object", "operationId": "patch_put_crm_message", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a CustomerMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerMessage" } } } } } } }, "\/api\/crm\/messages\/{companyId}\/{timestamp}\/new": { "get": { "tags": [ "CRM \/ CrmMessage" ], "summary": "This method will get all CustomerMessage Objects", "operationId": "get_get_crm_message_new", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "timestamp", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/crm\/messages\/{companyId}\/{timestamp}\/daily": { "get": { "tags": [ "CRM \/ CrmMessage" ], "summary": "This method will get CustomerMessages from given timestamp on (limit 500) and mapped by their date", "operationId": "get_get_crm_message_daily", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "timestamp", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/crm\/messages\/{id}\/adds\/attachments": { "post": { "tags": [ "CRM \/ CrmMessage" ], "summary": "Add an Attachment to a Message", "operationId": "post_post_crm_message_add_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add an Attachment to a CustomerMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerMessage" } } } } } } }, "\/api\/crm\/messages\/{id}\/deletes\/attachments": { "post": { "tags": [ "CRM \/ CrmMessage" ], "summary": "Remove an Attachment from CustomerMessage", "operationId": "post_post_crm_message_delete_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Remove an Attachment from a CustomerMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerMessage" } } } } } } }, "\/api\/crm\/tickets": { "get": { "tags": [ "CRM \/ CRMTicket" ], "summary": "This method will get all CustomerTicket Objects", "operationId": "get_crm_ticket_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "inportal", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "deleted", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "crmProject", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "crmProjectItem", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "createdByUser", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "assignedUser", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "archived", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "boolean" } }, { "name": "crmProjectCategoryArea", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "unifiedCategory", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "calculatedScoreDueDate", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "calculatedScoreBusinessValue", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "calculatedScore", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "businessValue", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "issuecategory", "in": "query", "description": "A category like website, hosting, marketing | Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "statusid", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "headline", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "duedate", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "ticketType", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "reopenDate", "in": "query", "description": "Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "sprint", "in": "query", "description": "The sprint this ticket is planned for. Tickets without a sprint are the backlog. | Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "storyPoints", "in": "query", "description": "Relative planning estimate used during sprint planning | Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "boardOrder", "in": "query", "description": "Manual position of the ticket inside its kanban column \/ sprint backlog | Requires access right: SCOPE, LOGGED_IN", "required": false, "schema": { "type": "string" } }, { "name": "aiUrgencyScore", "in": "query", "description": "Interner Dringlichkeits-Score 0-100 aus der KI-Triage (TicketAiTriageHelper), null = nicht bewertet. Nur fuer das Team sichtbar. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "aiEmergency", "in": "query", "description": "Die KI-Triage hat das Ticket als absoluten Notfall erkannt (das Team wurde zusaetzlich benachrichtigt). null = nicht geprueft. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of CustomerTicket objects", "content": { "application\/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/CustomerTicket" } } ] } } } } } }, "post": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Add a new Ticket", "operationId": "post_crm_ticket_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerTicket2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new Ticket", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket3" } } } } } } }, "\/api\/crm\/tickets\/satisfaction_report": { "get": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Ratings of finished tickets in a period (customer_panel_ticket_satisfaction_enabled): count,\naverage, distribution, per assignee and per area, and the comments.", "operationId": "get_crm_ticket_satisfaction_report", "parameters": [ { "name": "from", "in": "query", "description": "Start date (Y-m-d), default 90 days ago", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "End date (Y-m-d), default today", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The report", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/crm\/tickets\/{id}": { "get": { "tags": [ "CRM \/ CRMTicket" ], "summary": "This method will get a single Ticket with the given id", "operationId": "get_crm_ticket_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single Ticket", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket3" } } } } } }, "put": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Update a Ticket", "operationId": "put_crm_ticket_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerTicket2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a Ticket", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket3" } } } } } }, "patch": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Update a Ticket", "operationId": "patch_crm_ticket_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerTicket2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a Ticket", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket3" } } } } } } }, "\/api\/crm\/tickets\/sick_bulk": { "post": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Create several sick tickets (\"Massen-Krankmeldung\") at once and return a result per row.", "description": "Every row is handled like one row of the sick ticket CSV import (SickTicketImportService):\nit accepts the same column keys (PERSON_IDENTIFIER or name + school + class, START_DATE,\nEND_DATE, SICK_TICKET_DESCRIPTION and their aliases in IwSharedDataArrayHandler), applies the same timeframe rules and skips the same\nduplicates. Rows are independent: a skipped row does not stop the others.", "operationId": "post_crm_ticket_post_sick_bulk", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "rows": { "description": "Rows with the column keys of the sick ticket import (max. 500)", "type": "array", "items": { "properties": { "PERSON_IDENTIFIER": { "type": "string", "example": "123" }, "START_DATE": { "description": "Date or date and time; a date-only end date includes the whole day", "type": "string", "example": "2026-10-07" }, "END_DATE": { "type": "string", "example": "2026-10-09" }, "SICK_TICKET_DESCRIPTION": { "type": "string", "example": "Grippe" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The result of every row in the order of the request", "content": { "application\/json": { "schema": { "properties": { "created": { "type": "integer" }, "skipped": { "type": "integer" }, "rows": { "type": "array", "items": { "properties": { "row": { "description": "Index of the row in the request, starting at 0", "type": "integer" }, "status": { "type": "string", "enum": [ "created", "empty_row", "unknown_category", "missing_category", "missing_person", "invalid_timeframe", "duplicate" ] }, "ticket_id": { "type": "integer", "nullable": true }, "person_id": { "type": "integer", "nullable": true }, "person_name": { "type": "string", "nullable": true } }, "type": "object" } } }, "type": "object" } } } } } } }, "\/api\/crm\/tickets\/{id}\/ai_follow_up": { "post": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Create the follow-up ticket (\"Wiedervorlage\") the AI suggested for this ticket.", "description": "The suggestion comes from the opt-in AI follow-up detection\n(inwendo_crm_ticket_ai_follow_up_enabled). Creating a ticket needs the full ticket scope.", "operationId": "post_crm_ticket_ai_follow_up", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "source": { "description": "Key of the suggestion in ai_follow_ups", "type": "string", "example": "comment_12" }, "due": { "description": "Optional other due date", "type": "string", "example": "2026-03-15 09:00:00" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The created follow-up ticket", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket4" } } } } } } }, "\/api\/crm\/tickets\/{id}\/ai_follow_up\/dismiss": { "post": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Dismiss a follow-up the AI suggested for this ticket.", "operationId": "post_crm_ticket_ai_follow_up_dismiss", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "source": { "description": "Key of the suggestion in ai_follow_ups", "type": "string", "example": "comment_12" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The ticket", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket4" } } } } } } }, "\/api\/crm\/tickets\/{id}\/ai_summary": { "post": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Summarize the ticket and its history with the AI (customer_panel_ai_ticket_summary_enabled).", "description": "The summary is stored on the ticket (ai_summary, only for the team) and returned with it.", "operationId": "post_crm_ticket_ai_summary", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The ticket with its new summary", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket4" } } } } } } }, "\/api\/crm\/tickets\/{id}\/statuses": { "post": { "tags": [ "CRM \/ CRMTicket" ], "summary": "This method will set a new Status for the Ticket", "operationId": "post_crm_ticket_post_status", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Set a new Status for a Ticket", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket3" } } } } } } }, "\/api\/crm\/tickets\/{id}\/adds\/attachments": { "post": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Add a Attachment to a Ticket", "operationId": "post_crm_ticket_post_add_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add an Attachment to a Ticket", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket3" } } } } } } }, "\/api\/crm\/tickets\/{id}\/deletes\/attachments": { "post": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Remove an Attachment from Ticket", "operationId": "post_crm_ticket_post_delete_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Remove an Attachment from Ticket", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket3" } } } } } } }, "\/api\/crm\/tickets\/{id}\/board_positions": { "post": { "tags": [ "CRM \/ CRMTicket" ], "summary": "Moves a Ticket on the kanban board \/ in the sprint planning", "description": "A move can change the status (kanban column), the sprint and the manual position\ninside the column at once. Only the submitted values are applied.", "operationId": "post_crm_ticket_post_board_position", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TicketBoardPositionRequest" } }, "type": "object" } } } }, "responses": { "200": { "description": "Move a Ticket on the board", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicket3" } } } } } } }, "\/api\/crm\/sprints": { "get": { "tags": [ "CRM \/ CRMTicket \/ Sprints" ], "summary": "This method will get all Sprint Objects", "operationId": "get_crm_sprint_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "One of self::STATES | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "viewOrder", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of Sprint objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMSprint" } } } } } } }, "post": { "tags": [ "CRM \/ CRMTicket \/ Sprints" ], "summary": "Add a new Sprint", "operationId": "post_crm_sprint_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CRMSprint2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new Sprint", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMSprint" } } } } } } }, "\/api\/crm\/sprints\/{id}": { "get": { "tags": [ "CRM \/ CRMTicket \/ Sprints" ], "summary": "This method will get a single Sprint with the given id", "operationId": "get_crm_sprint_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single Sprint", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMSprint" } } } } } }, "put": { "tags": [ "CRM \/ CRMTicket \/ Sprints" ], "summary": "Update a single Sprint with the given id", "operationId": "put_crm_sprint_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CRMSprint2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single Sprint with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMSprint" } } } } } }, "delete": { "tags": [ "CRM \/ CRMTicket \/ Sprints" ], "summary": "This method will delete a single Sprint with the given id", "operationId": "delete_crm_sprint_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single Sprint with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMSprint" } } } } } }, "patch": { "tags": [ "CRM \/ CRMTicket \/ Sprints" ], "summary": "Update a single Sprint with the given id", "operationId": "patch_crm_sprint_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CRMSprint2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single Sprint with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMSprint" } } } } } } }, "\/api\/crm\/ticket\/comments\/{ticketId}": { "get": { "tags": [ "CRM \/ CRMTicketComment" ], "summary": "This method will get all TicketComments Objects for a certain ticket", "operationId": "get_crm_ticket_comment_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of TicketComment objects for a Ticket", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CustomerTicketComment" } } } } } } }, "post": { "tags": [ "CRM \/ CRMTicketComment" ], "summary": "Add a new TicketComment", "operationId": "post_crm_ticket_comment_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerTicketComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new TicketComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicketComment" } } } } } } }, "\/api\/crm\/ticket\/comments\/{id}": { "put": { "tags": [ "CRM \/ CRMTicketComment" ], "summary": "This method will update a CustomerTicketComment Object with the given id", "operationId": "put_crm_ticket_comment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerTicketComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a TicketComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicketComment" } } } } } }, "delete": { "tags": [ "CRM \/ CRMTicketComment" ], "summary": "This method will remove a CustomerTicketComment Object with the given id", "operationId": "delete_crm_ticket_comment_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a TicketComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicketComment" } } } } } }, "patch": { "tags": [ "CRM \/ CRMTicketComment" ], "summary": "This method will update a CustomerTicketComment Object with the given id", "operationId": "patch_crm_ticket_comment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerTicketComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a TicketComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicketComment" } } } } } } }, "\/api\/crm\/ticket\/comments\/{id}\/adds\/attachments": { "post": { "tags": [ "CRM \/ CRMTicketComment" ], "summary": "Add a Attachment to a Ticket_Comment", "operationId": "post_crm_ticket_comment_post_comment_add_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add an Attachment to a TicketComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicketComment" } } } } } } }, "\/api\/crm\/ticket\/comments\/{id}\/deletes\/attachments": { "post": { "tags": [ "CRM \/ CRMTicketComment" ], "summary": "Remove an Attachment from Ticket Comment", "operationId": "post_crm_ticket_comment_post_comment_delete_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Remove an Attachment from TicketComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CustomerTicketComment" } } } } } } }, "\/api\/crm\/cancellation_terms": { "get": { "tags": [ "CRM \/ Cancellation Terms" ], "summary": "Preview the cancellation terms for a product (or the club default when no product is given).", "operationId": "get_crm_get_cancellation_terms", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "productId", "in": "query", "description": "PredefinedBillingItem id. Omitted = club default from settings.", "required": false, "schema": { "type": "integer" } }, { "name": "receivedAt", "in": "query", "description": "Date the cancellation was received, defaults to today. Accepts d.m.Y or Y-m-d.", "required": false, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "How many upcoming term dates to return (1-24, default 4).", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Resolved cancellation rule and the next allowed end dates" } } } }, "\/api\/cp\/self_service\/cancellation_terms": { "get": { "tags": [ "CRM \/ Cancellation Terms" ], "summary": "Cancellation terms for the memberships a member actually holds.", "description": "Deliberately takes no product: the products are derived from the person's active\nmemberships, so a member cannot read the terms of an arbitrary product.", "operationId": "get_cp_get_cancellation_terms", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "personId", "in": "query", "description": "Person in the current account. Defaults to the person of the session.", "required": false, "schema": { "type": "integer" } }, { "name": "receivedAt", "in": "query", "description": "Date the cancellation was received, defaults to today. Accepts d.m.Y or Y-m-d.", "required": false, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "How many upcoming term dates to return (1-24, default 4).", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Terms per active membership, plus the term that governs leaving the club" } } } }, "\/api\/crm\/linked_person": { "get": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Returns a list of people with matching linking identifier", "operationId": "get_get_linked_people", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Updates a single person with the given identifier and matching linking identifier", "operationId": "put_update_linked_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Updates a single person with the given identifier and matching linking identifier", "operationId": "post_update_linked_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Updates a single person with the given identifier and matching linking identifier", "operationId": "patch_update_linked_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/crm\/multi_linked_person": { "put": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Updates multiple persons with the given identifiers and matching linking identifiers", "operationId": "put_multi_update_linked_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Updates multiple persons with the given identifiers and matching linking identifiers", "operationId": "post_multi_update_linked_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Updates multiple persons with the given identifiers and matching linking identifiers", "operationId": "patch_multi_update_linked_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/crm\/linked_person\/{id}": { "get": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Return a single person with the given id and matching linking identifier", "operationId": "get_get_linked_person", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/crm\/linked_person_sso\/{id}": { "get": { "tags": [ "CRM \/ CRMPerson" ], "summary": "Return a login link for the person with the given id and matching linking identifier", "operationId": "get_get_linked_person_sso", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/paymentgoals": { "get": { "tags": [ "Billing \/ PaymentGoal" ], "summary": "Returns a list of all PaymentGoal", "operationId": "get_invoice_paymentgoal_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "dateString", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "globalDefault", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of PaymentGoal objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PaymentGoal" } } } } } } } }, "\/api\/invoice\/paymenttypes": { "get": { "tags": [ "Billing \/ PaymentType" ], "summary": "Returns a list of all PaymentType", "operationId": "get_invoice_paymenttype_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all PaymentType", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PaymentType" } } } } } } } }, "\/api\/invoice\/billing_payment_profile": { "get": { "tags": [ "Billing \/ BillingPaymentProfile" ], "summary": "This method will get all BillingPaymentProfile Objects", "operationId": "get_billing_payment_profile_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BillingPaymentProfile objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BillingPaymentProfile" } } } } } } }, "post": { "tags": [ "Billing \/ BillingPaymentProfile" ], "summary": "Add a new BillingPaymentProfile", "operationId": "post_billing_payment_profile_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillingPaymentProfile2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BillingPaymentProfile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingPaymentProfile" } } } } } } }, "\/api\/invoice\/billing_payment_profile\/{identifier}": { "get": { "tags": [ "Billing \/ BillingPaymentProfile" ], "summary": "This method will get a single BillingPaymentProfile with the given id", "operationId": "get_billing_payment_profile_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BillingPaymentProfile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingPaymentProfile" } } } } } }, "put": { "tags": [ "Billing \/ BillingPaymentProfile" ], "summary": "Update a BillingPaymentProfile", "operationId": "put_billing_payment_profile_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillingPaymentProfile2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BillingPaymentProfile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingPaymentProfile" } } } } } }, "patch": { "tags": [ "Billing \/ BillingPaymentProfile" ], "summary": "Update a BillingPaymentProfile", "operationId": "patch_billing_payment_profile_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillingPaymentProfile2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BillingPaymentProfile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingPaymentProfile" } } } } } } }, "\/api\/invoice\/billing_payout_account": { "get": { "tags": [ "Billing \/ BillingPayoutAccount" ], "summary": "This method will get all BillingPayoutAccount Objects", "operationId": "get_billing_payout_account_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BillingPayoutAccount objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BillingPayoutAccount" } } } } } } }, "post": { "tags": [ "Billing \/ BillingPayoutAccount" ], "summary": "Add a new BillingPayoutAccount", "operationId": "post_billing_payout_account_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillingPayoutAccount2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BillingPayoutAccount", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingPayoutAccount" } } } } } } }, "\/api\/invoice\/billing_payout_account\/{identifier}": { "get": { "tags": [ "Billing \/ BillingPayoutAccount" ], "summary": "This method will get a single BillingPayoutAccount with the given id", "operationId": "get_billing_payout_account_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BillingPayoutAccount", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingPayoutAccount" } } } } } }, "put": { "tags": [ "Billing \/ BillingPayoutAccount" ], "summary": "Update a BillingPayoutAccount", "operationId": "put_billing_payout_account_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillingPayoutAccount2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BillingPayoutAccount", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingPayoutAccount" } } } } } }, "patch": { "tags": [ "Billing \/ BillingPayoutAccount" ], "summary": "Update a BillingPayoutAccount", "operationId": "patch_billing_payout_account_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillingPayoutAccount2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BillingPayoutAccount", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingPayoutAccount" } } } } } } }, "\/api\/invoice\/billing_dry_run": { "get": { "tags": [ "Billing \/ BillingDryRun" ], "summary": "This method will get all BillingDryRun objects - without the simulated invoices", "operationId": "get_billing_dry_run_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BillingDryRun objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BillingDryRun" } } } } } } }, "post": { "tags": [ "Billing \/ BillingDryRun" ], "summary": "Start a new simulated billing run (\"dry run\").", "description": "The run is executed in the background. Nothing is persisted by the simulation itself - only the resulting\nBillingDryRun record with its items is stored. Poll the returned record until its status is done or failed.", "operationId": "post_billing_dry_run_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillingDryRun2" } }, "type": "object" } } } }, "responses": { "200": { "description": "The scheduled dry run", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingDryRun3" } } } } } } }, "\/api\/invoice\/billing_dry_run\/{identifier}": { "get": { "tags": [ "Billing \/ BillingDryRun" ], "summary": "This method will get a single BillingDryRun with the given id including all simulated invoices", "operationId": "get_billing_dry_run_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BillingDryRun", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingDryRun3" } } } } } }, "put": { "tags": [ "Billing \/ BillingDryRun" ], "summary": "Archive a BillingDryRun so it disappears from the list without losing its result.", "description": "Deleting a run drops its simulated invoices and its log for good, which is the right thing once a result was\nreviewed. Archiving is the reversible way out of the list for a result one wants to keep - it can still be\nopened and exported, and the flag can be taken back. Everything else about a run is written by the simulation\nitself, so the deleted flag is the only field this accepts.", "operationId": "put_billing_dry_run_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillingDryRun4" } }, "type": "object" } } } }, "responses": { "200": { "description": "The updated BillingDryRun", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingDryRun3" } } } } } }, "delete": { "tags": [ "Billing \/ BillingDryRun" ], "summary": "Delete a BillingDryRun together with its simulated invoices.", "description": "The record is removed for good instead of being flagged as deleted: a run holds up to\nBillingDryRunCollector::MAX_ITEMS simulated invoices with their positions and a log of a few hundred kilobytes,\nnone of which describes anything that ever happened. Keeping that around after the result was reviewed only\nfills up the database.\n\nA run that is still scheduled or executing is kept - the background process would fail on its own result.", "operationId": "delete_billing_dry_run_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The deleted BillingDryRun", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingDryRun" } } } } } }, "patch": { "tags": [ "Billing \/ BillingDryRun" ], "summary": "Archive a BillingDryRun so it disappears from the list without losing its result.", "description": "Deleting a run drops its simulated invoices and its log for good, which is the right thing once a result was\nreviewed. Archiving is the reversible way out of the list for a result one wants to keep - it can still be\nopened and exported, and the flag can be taken back. Everything else about a run is written by the simulation\nitself, so the deleted flag is the only field this accepts.", "operationId": "patch_billing_dry_run_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillingDryRun4" } }, "type": "object" } } } }, "responses": { "200": { "description": "The updated BillingDryRun", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillingDryRun3" } } } } } } }, "\/api\/invoice\/billing_dry_run\/{identifier}\/log": { "get": { "tags": [ "Billing \/ BillingDryRun" ], "summary": "Downloads the console output of a simulated billing run as a plain text file.", "description": "The log holds one line per simulated invoice and reaches several megabytes on a large installation. Sending it\ninside the JSON detail response made every reload of the result view slow, so it is offered as a file instead.", "operationId": "get_billing_dry_run_get_log", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The log of the BillingDryRun as a text file", "content": { "text\/plain": { "schema": { "type": "string", "format": "binary" } } } } } } }, "\/api\/invoice\/billing_dry_run_item": { "get": { "tags": [ "Billing \/ BillingDryRun" ], "summary": "This method will get all simulated invoices of a single BillingDryRun", "operationId": "get_billing_dry_run_item_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BillingDryRunItem objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BillingDryRunItem" } } } } } } } }, "\/api\/billing\/payment_gateway\/provider_schema": { "get": { "tags": [ "Billing \/ Payment Gateway" ], "summary": "Get provider schema from payment gateway (with fallback)", "operationId": "get_billing_payment_gateway_provider_schema", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the available payment provider schema" } } } }, "\/api\/billing\/payment_gateway\/additional_setup": { "post": { "tags": [ "Billing \/ Payment Gateway" ], "summary": "Setup payment gateway for additional service user", "operationId": "post_billing_payment_gateway_additional_setup", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Sets up an additional payment gateway service user", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SimpleChange" } } } } } } }, "\/api\/billing\/payment_gateway\/connections": { "get": { "tags": [ "Billing \/ Payment Gateway" ], "summary": "Return normalized Stripe, Mollie and GoCardless connection states.", "operationId": "get_billing_payment_gateway_connections", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns normalized payment provider connection states" } } } }, "\/api\/billing\/payment_gateway\/connections\/{provider}\/authorize": { "post": { "tags": [ "Billing \/ Payment Gateway" ], "summary": "Start provider authorization and return the external authorization URL.", "operationId": "post_billing_payment_gateway_connection_authorize", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "required": [ "redirectUrl" ], "properties": { "redirectUrl": { "type": "string", "format": "uri" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns the external provider authorization URL" } } } }, "\/api\/billing\/payment_gateway\/connections\/{provider}": { "delete": { "tags": [ "Billing \/ Payment Gateway" ], "summary": "Disconnect a connected merchant account.", "operationId": "delete_billing_payment_gateway_connection_disconnect", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Disconnects a connected payment provider", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/billing\/payment_gateway\/connections\/mollie\/profiles": { "get": { "tags": [ "Billing \/ Payment Gateway" ], "summary": "List profiles belonging to the connected Mollie organization.", "operationId": "get_billing_payment_gateway_mollie_profiles", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns Mollie payment profiles for the connected organization" } } } }, "\/api\/billing\/payment_gateway\/connections\/mollie\/profile": { "put": { "tags": [ "Billing \/ Payment Gateway" ], "summary": "Select the Mollie payment profile used for connected payments.", "operationId": "put_billing_payment_gateway_mollie_profile_select", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "required": [ "profileId" ], "properties": { "profileId": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns the updated Mollie provider connection" } } } }, "\/api\/invoice\/invoices": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will get all Invoice Objects", "operationId": "get_get_invoices", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of Invoice objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice" } } } } } } }, "post": { "tags": [ "Billing \/ Invoice" ], "summary": "Creates a single Invoice", "operationId": "post_post_invoice", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "invoice": { "$ref": "#\/components\/schemas\/Invoice2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single Invoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice3" } } } } } } }, "\/api\/invoice\/proforma_invoices": { "get": { "tags": [ "Billing \/ ProformaInvoice" ], "summary": "Returns a list of proforma invoice entries.", "operationId": "get_proforma_invoice_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of ProformaInvoice objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ProformaInvoice" } } } } } } } }, "\/api\/invoice\/proforma_invoices\/{identifier}\/pdf": { "get": { "tags": [ "Billing \/ ProformaInvoice" ], "summary": "Returns the PDF document.", "operationId": "get_proforma_invoice_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the ProformaInvoice as PDF" } } } }, "\/api\/invoice\/proforma_invoices\/{identifier}": { "get": { "tags": [ "Billing \/ ProformaInvoice" ], "summary": "Returns a single proforma invoice entry.", "operationId": "get_proforma_invoice_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a ProformaInvoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProformaInvoice2" } } } } } } }, "\/api\/invoice\/invoices\/creation_defaults": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "Returns the default values used for creating free invoices.", "description": "All fields are optional and only populated when configured via settings.", "operationId": "get_get_invoice_creation_defaults", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the invoice creation defaults", "content": { "application\/json": { "schema": { "properties": { "default_accounting_type": { "description": "Type string of the default AccountingType (e.g. 'general'). Null if not configured.", "type": "string", "nullable": true }, "default_multiple_tax_rates": { "description": "Whether 'apply multiple tax rates' should be enabled by default.", "type": "boolean", "nullable": true }, "default_unit": { "description": "Default unit for free positions (e.g. 'pauschal'). Null if not configured.", "type": "string", "nullable": true }, "default_quantity": { "description": "Default quantity for free positions. Null if not configured.", "type": "number", "format": "float", "nullable": true }, "default_price_is_brutto": { "description": "Whether price should default to brutto instead of netto.", "type": "boolean", "nullable": true } }, "type": "object" } } } } } } }, "\/api\/invoice\/invoices\/{id}\/pdf": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will print an Invoice as PDF (optional with ZUGFeRD XML)", "operationId": "get_get_invoice_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the Invoice as PDF file" } } } }, "\/api\/invoice\/invoices\/{id}\/girocode": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will return the GiroCode (EPC QR code) of an open Invoice for a bank transfer", "description": "Requires the setting inwendo_invoice_girocode_enabled. Fails with 400 if the invoice gets no code\n(cancelled, paid, nothing to pay, direct debit or no valid IBAN in the company data).", "operationId": "get_get_invoice_girocode", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns payload, SVG, amount and remittance of the GiroCode" } } } }, "\/api\/invoice\/invoices\/{id}\/zugferd": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will print an ZUGFeRD XML", "operationId": "get_get_invoice_zugferd", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the Invoice as ZUGFeRD XML" } } } }, "\/api\/invoice\/invoices\/{identifier}": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will get a single Invoice Object with the given id", "operationId": "get_get_invoice", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single Invoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice4" } } } } } } }, "\/api\/invoice\/invoices\/{offerIdentifier}\/offers\/{percentage}": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will get a new Invoice Object for the given offer id", "operationId": "get_get_invoice_offer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "offerIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "percentage", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a new Invoice for the given Offer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice5" } } } } } } }, "\/api\/invoice\/invoices\/{projectItemIdentifier}\/projectitem": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will get a new Invoice Object for a single projectitem", "operationId": "get_get_invoice_projectitem", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "projectItemIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a new Invoice for a single ProjectItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice5" } } } } } } }, "\/api\/invoice\/invoices\/{projectIdentifier}\/project": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will get a new Invoice Object for the project", "operationId": "get_get_invoice_project", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "projectIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a new Invoice for a Project", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice5" } } } } } } }, "\/api\/invoice\/invoices\/{eventSignUpIdentifier}\/eventsignup": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will get a new Invoice Object for the given event sign up", "operationId": "get_get_invoice_eventsignup", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventSignUpIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a new Invoice for an EventSignUp", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice5" } } } } } } }, "\/api\/invoice\/invoices\/{bookingIdentifier}\/booking": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will get a new Invoice Object for the given booking", "operationId": "get_get_invoice_booking", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookingIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a new Invoice for a Booking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice5" } } } } } } }, "\/api\/invoice\/invoices\/{bookingGroupIdentifier}\/booking_group": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will get a new Invoice Object for the given booking group", "operationId": "get_get_invoice_booking_group", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookingGroupIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a new Invoice for a BookingGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice5" } } } } } } }, "\/api\/invoice\/invoices\/{eventIdentifier}\/events": { "post": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will save new Invoice Objects for all entries of event", "operationId": "post_post_invoice_event", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Creates Invoices for all entries of an Event" } } } }, "\/api\/invoice\/invoices\/{logBookEntryIdentifier}\/logbookentryadd": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will get a new Invoice Object for the given PersonLogBookEntry", "operationId": "get_get_invoice_logbookentryadd", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "logBookEntryIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a new Invoice for a LogBookEntry (add)", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice6" } } } } } } }, "\/api\/invoice\/invoices\/{logBookEntryIdentifier}\/logbookentrydelete": { "get": { "tags": [ "Billing \/ Invoice" ], "summary": "This method will get a new Invoice Object for the given PersonLogBookEntry", "operationId": "get_get_invoice_logbookentrydelete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "logBookEntryIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a new Invoice for a LogBookEntry (delete)", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice6" } } } } } } }, "\/api\/invoice\/invoice\/{id}\/add\/to\/company": { "post": { "tags": [ "Billing \/ Invoice" ], "summary": "Add an Invoice to a CRMCompany", "operationId": "post_post_invoice_add_to_company", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add an Invoice to a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany23" } } } } } } }, "\/api\/invoice\/invoice\/{id}\/delete\/from\/company": { "post": { "tags": [ "Billing \/ Invoice" ], "summary": "Delete an Invoice from a CRMCompany", "operationId": "post_post_invoice_delete_from_company", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Remove an Invoice from a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany23" } } } } } } }, "\/api\/invoice\/invoice\/{id}\/close": { "post": { "tags": [ "Billing \/ Invoice" ], "summary": "Close an Invoice", "operationId": "post_post_invoice_close", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Close an Invoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice5" } } } } } } }, "\/api\/invoice\/invoice\/{id}\/payment": { "post": { "tags": [ "Billing \/ Invoice" ], "summary": "Record a partial payment of an open Invoice", "description": "Only with the setting billing_invoice_partial_payment. Once the payments reach the gross\namount, the invoice counts as paid.", "operationId": "post_post_invoice_payment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "amount": { "description": "Paid amount (gross)", "type": "number", "example": 595 }, "paymentDate": { "description": "Defaults to today", "type": "string", "example": "2026-02-20" }, "cashDiscount": { "description": "Skonto (gross) deducted with the final payment; needs billing_invoice_cash_discount", "type": "number", "example": 23.8 } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Record a partial payment of an Invoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice5" } } } } } } }, "\/api\/invoice\/invoice\/{id}\/cancel": { "post": { "tags": [ "Billing \/ Invoice" ], "summary": "Cancel an Invoice", "operationId": "post_post_invoice_cancel", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cancel an Invoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice5" } } } } } } }, "\/api\/invoice\/invoice\/{identifier}\/mail_intend": { "post": { "tags": [ "Billing \/ Invoice" ], "summary": "Set mail intend for an Invoice", "operationId": "post_post_invoice_mail_intend", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Set mail intend for an Invoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice7" } } } } } } }, "\/api\/invoice\/invoice\/{id}\/buchhaltungsbutler_push": { "post": { "tags": [ "Billing \/ Invoice" ], "summary": "Push an Invoice to BuchhaltungsButler (manual transfer \/ re-transfer)", "operationId": "post_post_invoice_buchhaltungsbutler_push", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Push an Invoice to BuchhaltungsButler", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Invoice5" } } } } } } }, "\/api\/invoice\/taxes": { "get": { "tags": [ "Billing \/ Tax" ], "summary": "Returns a list of all Tax", "operationId": "get_invoice_tax_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all Tax", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Tax" } } } } } } } }, "\/api\/invoice\/accountingtypes": { "get": { "tags": [ "Billing \/ AccountingType" ], "summary": "Returns a list of all AccountingType", "operationId": "get_invoice_accounting_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all AccountingType", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AccountingType" } } } } } } }, "post": { "tags": [ "Billing \/ AccountingType" ], "summary": "Add a new AccountingType", "operationId": "post_post_invoice_accounting", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AccountingType" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new AccountingType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AccountingType" } } } } } } }, "\/api\/invoice\/accountingtypes\/{identifier}": { "get": { "tags": [ "Billing \/ AccountingType" ], "summary": "Get a single AccountingType", "operationId": "get_get_invoice_accounting", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single AccountingType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AccountingType" } } } } } }, "put": { "tags": [ "Billing \/ AccountingType" ], "summary": "Update an AccountingType", "operationId": "put_put_invoice_accounting", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AccountingType" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an AccountingType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AccountingType" } } } } } } }, "\/api\/invoice\/offers": { "get": { "tags": [ "Billing \/ Offer" ], "summary": "This method will get all Offer Objects", "operationId": "get_get_offers", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of Offer objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Offer2" } } } } } } }, "post": { "tags": [ "Billing \/ Offer" ], "summary": "Creates a single Offer", "operationId": "post_post_offer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "offer": { "$ref": "#\/components\/schemas\/Offer3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single Offer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Offer4" } } } } } } }, "\/api\/invoice\/offers\/{identifier}\/pdf": { "get": { "tags": [ "Billing \/ Offer" ], "summary": "This method will print an Offer as PDF", "operationId": "get_get_offer_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/offers\/{identifier}": { "get": { "tags": [ "Billing \/ Offer" ], "summary": "This method will get a single Offer Object with the given id", "operationId": "get_get_offer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single Offer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Offer4" } } } } } } }, "\/api\/invoice\/offer\/{id}\/add\/to\/company": { "post": { "tags": [ "Billing \/ Offer" ], "summary": "Add an Offer to a CRMCompany", "operationId": "post_post_offer_add_to_company", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add an Offer to a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany23" } } } } } } }, "\/api\/invoice\/offer\/{id}\/delete\/from\/company": { "post": { "tags": [ "Billing \/ Offer" ], "summary": "Delete an Offer from a CRMCompany", "operationId": "post_post_offer_delete_from_company", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete an Offer from a CRMCompany", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CRMCompany23" } } } } } } }, "\/api\/invoice\/offer\/{identifier}\/close": { "post": { "tags": [ "Billing \/ Offer" ], "summary": "Close an Offer", "operationId": "post_post_offer_close", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Close an Offer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Offer4" } } } } } } }, "\/api\/invoice\/offer\/{identifier}\/mail_intend": { "post": { "tags": [ "Billing \/ Offer" ], "summary": "Set mail intend for an Offer", "operationId": "post_post_offer_mail_intend", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Set mail intend for an Offer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Offer4" } } } } } } }, "\/api\/invoice\/predefinedbillingitems": { "get": { "tags": [ "Billing \/ PredefinedBillingItem" ], "summary": "Returns a list of PredefinedBillingItem objects", "operationId": "get_get_predefinedbillingitems", "parameters": [ { "name": "deleted", "in": "query", "description": "Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "string" } }, { "name": "billingType", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billingTypeCategory", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "isPreferred", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "isDefault", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "isGlobal", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "isDiscount", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "isFree", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "isPassive", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "unifiedCatEmpty", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "integer" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "conditionDateAfter", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "conditionDateBefore", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "conditionCountryCode", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "conditionZipCodeFrom", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "conditionZipCodeTo", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "conditionTimeAfterHour", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "conditionTimeBeforeHour", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "conditionMaxLength", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "conditionBookingContentType", "in": "query", "description": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "usageTimeBase", "in": "query", "description": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or BILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseLocation", "in": "query", "description": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "conditionDayOfWeekMask", "in": "query", "description": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "conditionFirstUsageOnly", "in": "query", "description": "Charge applies only once per usage record (first matching section, quantity 1) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sku", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "barcode", "in": "query", "description": "Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "producerGuaranteeYears", "in": "query", "description": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig). Producer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label. | Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "producerBrand", "in": "query", "description": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\" des EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability. | Requires access right: SCOPE, PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "cancellationTermUnit", "in": "query", "description": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club default from settings. See CancellationTermCalculator::TERM_UNITS. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "cancellationNoticeValue", "in": "query", "description": "Numeric value of the notice period before the cancellation term. Null = inherit from settings. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "cancellationNoticeUnit", "in": "query", "description": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "externalAccessMode", "in": "query", "description": "Access granted by an external purchase, independently of billing recurrence or event budgets. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "externalAccessDurationDays", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of PredefinedBillingItem objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PredefinedBillingItem" } } } } } } }, "post": { "tags": [ "Billing \/ PredefinedBillingItem" ], "summary": "Creates a single PredefinedBillingItem", "operationId": "post_post_predefinedbillingitem", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "predefinedbillingitem": { "$ref": "#\/components\/schemas\/PredefinedBillingItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single PredefinedBillingItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PredefinedBillingItem" } } } } } } }, "\/api\/invoice\/predefinedbillingitems\/{identifier}": { "get": { "tags": [ "Billing \/ PredefinedBillingItem" ], "summary": "This method will get a single PredefinedBillingItem Object with the given id", "operationId": "get_get_predefinedbillingitem", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single PredefinedBillingItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PredefinedBillingItem" } } } } } } }, "\/api\/invoice\/predefinedbillingitems\/{id}": { "put": { "tags": [ "Billing \/ PredefinedBillingItem" ], "summary": "This method will update a PredefinedBillingItem Object", "operationId": "put_put_predefinedbillingitem", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "predefinedbillingitem": { "$ref": "#\/components\/schemas\/PredefinedBillingItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a PredefinedBillingItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PredefinedBillingItem" } } } } } }, "patch": { "tags": [ "Billing \/ PredefinedBillingItem" ], "summary": "This method will update a PredefinedBillingItem Object", "operationId": "patch_put_predefinedbillingitem", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "predefinedbillingitem": { "$ref": "#\/components\/schemas\/PredefinedBillingItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a PredefinedBillingItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PredefinedBillingItem" } } } } } } }, "\/api\/invoice\/predefinedbillingitems\/label\/info\/{identifier}": { "get": { "tags": [ "Billing \/ ProductLabel" ], "summary": "Public JSON endpoint: producer guarantee, EU GARAN eligibility and availability + public URL of\nevery label type. Also answers for unknown products (found=false, all labels unavailable) with\nthe URLs still pointing at the show endpoint, so a shop can embed them blindly.", "operationId": "get_billing_product_label_info", "parameters": [ { "name": "identifier", "in": "path", "description": "Any unique product identifier", "required": true, "schema": { "type": "string", "pattern": ".+" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/predefinedbillingitems\/label\/{labelType}\/{identifier}": { "get": { "tags": [ "Billing \/ ProductLabel" ], "summary": "Public image endpoint: serves the label of the given type for the product identified by any\nunique identifier (id, short_identifier, slug, SKU, barcode, import ids). An ECS product is\nfound by both of its import ids, `ecs_118760` and `ecs_{source_system}_item_118760`. A trailing\nfile extension (.png, .jpg, .svg, ...) is ignored, so the URL may look like an image file.", "description": "Fallback when the product or its label is missing or not virus checked yet\n(`?fallback=default|transparent|404`, default `default`): the default configured in\n`billing_product_label_default_` (attachment download link -> file, http(s) URL ->\n302), otherwise a transparent 1x1 PNG. 404 only on request.", "operationId": "get_billing_product_label_show", "parameters": [ { "name": "labelType", "in": "path", "description": "energy_label | garan_label | garan_label_pictogram (aliases: energy, garan, garan_pictogram, pictogram, nested)", "required": true, "schema": { "type": "string", "pattern": "[a-zA-Z_\\-]+" } }, { "name": "identifier", "in": "path", "description": "Any unique product identifier, an image file extension may be appended", "required": true, "schema": { "type": "string", "pattern": ".+" } }, { "name": "fallback", "in": "query", "description": "default | transparent | 404", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "head": { "tags": [ "Billing \/ ProductLabel" ], "summary": "Public image endpoint: serves the label of the given type for the product identified by any\nunique identifier (id, short_identifier, slug, SKU, barcode, import ids). An ECS product is\nfound by both of its import ids, `ecs_118760` and `ecs_{source_system}_item_118760`. A trailing\nfile extension (.png, .jpg, .svg, ...) is ignored, so the URL may look like an image file.", "description": "Fallback when the product or its label is missing or not virus checked yet\n(`?fallback=default|transparent|404`, default `default`): the default configured in\n`billing_product_label_default_` (attachment download link -> file, http(s) URL ->\n302), otherwise a transparent 1x1 PNG. 404 only on request.", "operationId": "head_billing_product_label_show", "parameters": [ { "name": "labelType", "in": "path", "description": "energy_label | garan_label | garan_label_pictogram (aliases: energy, garan, garan_pictogram, pictogram, nested)", "required": true, "schema": { "type": "string", "pattern": "[a-zA-Z_\\-]+" } }, { "name": "identifier", "in": "path", "description": "Any unique product identifier, an image file extension may be appended", "required": true, "schema": { "type": "string", "pattern": ".+" } }, { "name": "fallback", "in": "query", "description": "default | transparent | 404", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/product_label\/garan_pictogram\/{years}": { "get": { "tags": [ "Billing \/ ProductLabel" ], "summary": "Public: the GARAN pictogram (\"nested label\") pre-rendered from the official EU template for a\ngiven number of years - independent of a product, e.g. for a shop that knows the years\nitself. `\/garan_pictogram\/5`, `\/garan_pictogram\/5.svg`, `\/garan_pictogram\/10.png`.", "description": "Available for 3, 4, 5, 6, 7, 8, 9, 10, 15 and 20 years; anything else is a 404.", "operationId": "get_billing_product_label_garan_pictogram_generate", "parameters": [ { "name": "years", "in": "path", "description": "Producer guarantee in whole years (3-10, 15, 20), optional .png or .svg extension", "required": true, "schema": { "type": "string", "pattern": "[0-9]+(?:[.,][0-9])?(?:\\.(?:svg|png))?" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "head": { "tags": [ "Billing \/ ProductLabel" ], "summary": "Public: the GARAN pictogram (\"nested label\") pre-rendered from the official EU template for a\ngiven number of years - independent of a product, e.g. for a shop that knows the years\nitself. `\/garan_pictogram\/5`, `\/garan_pictogram\/5.svg`, `\/garan_pictogram\/10.png`.", "description": "Available for 3, 4, 5, 6, 7, 8, 9, 10, 15 and 20 years; anything else is a 404.", "operationId": "head_billing_product_label_garan_pictogram_generate", "parameters": [ { "name": "years", "in": "path", "description": "Producer guarantee in whole years (3-10, 15, 20), optional .png or .svg extension", "required": true, "schema": { "type": "string", "pattern": "[0-9]+(?:[.,][0-9])?(?:\\.(?:svg|png))?" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/attachments\/product_labels\/{identifier}\/{labelType}": { "post": { "tags": [ "Billing \/ ProductLabel" ], "summary": "Upload (replace) one label of a product. Multipart form `attachment[file]`, optional\n`attachment[producerGuaranteeYears]` (e.g. \"5\" or \"2,5\").", "operationId": "post_billing_product_label_post_attachment", "parameters": [ { "name": "identifier", "in": "path", "description": "Any unique product identifier", "required": true, "schema": { "type": "string" } }, { "name": "labelType", "in": "path", "description": "energy_label | garan_label | garan_label_pictogram", "required": true, "schema": { "type": "string", "pattern": "[a-zA-Z_\\-]+" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "properties": { "attachment[file]": { "description": "Label file: png, jpeg, webp, svg, gif or pdf, max. 20 MB", "type": "string", "format": "binary" }, "attachment[producerGuaranteeYears]": { "description": "Optional producer guarantee in years, whole or .5 steps", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Uploads a product label and returns the product", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PredefinedBillingItem" } } } } } } }, "\/api\/attachments\/product_labels\/auto_match": { "post": { "tags": [ "Billing \/ ProductLabel" ], "summary": "Auto match upload: the file name names the product (SKU, EAN \/ barcode, short identifier,\n...) and optionally the label type (`..._piktogramm.png`, default `attachment[labelType]`,\notherwise the GARAN label). The label is linked when exactly one product matches and it has\nno uploaded label of this type yet - an existing label is never replaced. Business outcomes\n(no product, ambiguous, label exists, invalid file) are answered with 200 and a status.", "description": "Multipart form `attachment[file]`, optional `attachment[labelType]`.", "operationId": "post_billing_product_label_auto_match", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "properties": { "attachment[file]": { "description": "Label file named after the product: png, jpeg, webp, svg, gif or pdf, max. 20 MB", "type": "string", "format": "binary" }, "attachment[labelType]": { "description": "Label type when the file name does not name one: energy_label | garan_label | garan_label_pictogram (default garan_label)", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Match result: filename, status (linked | label_exists | not_found | ambiguous | error), matched, label_type, product_id, product_name, candidates, message", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/invoice\/predefinedbillingitems\/{identifier}\/label\/{labelType}": { "post": { "tags": [ "Billing \/ ProductLabel" ], "summary": "Upload (replace) one label of a product. Multipart form `attachment[file]`, optional\n`attachment[producerGuaranteeYears]` (e.g. \"5\" or \"2,5\").", "operationId": "post_billing_product_label_post", "parameters": [ { "name": "identifier", "in": "path", "description": "Any unique product identifier", "required": true, "schema": { "type": "string" } }, { "name": "labelType", "in": "path", "description": "energy_label | garan_label | garan_label_pictogram", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "properties": { "attachment[file]": { "description": "Label file: png, jpeg, webp, svg, gif or pdf, max. 20 MB", "type": "string", "format": "binary" }, "attachment[producerGuaranteeYears]": { "description": "Optional producer guarantee in years, whole or .5 steps", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Uploads a product label and returns the product", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PredefinedBillingItem" } } } } } }, "delete": { "tags": [ "Billing \/ ProductLabel" ], "summary": "Remove one label of a product (file and attachment are deleted).", "operationId": "delete_billing_product_label_delete", "parameters": [ { "name": "identifier", "in": "path", "description": "Any unique product identifier", "required": true, "schema": { "type": "string" } }, { "name": "labelType", "in": "path", "description": "energy_label | garan_label | garan_label_pictogram", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Removes a product label and returns the product", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PredefinedBillingItem" } } } } } } }, "\/api\/invoice\/billingitemtypes": { "get": { "tags": [ "Billing \/ BillingItemType" ], "summary": "Returns a list of all BillingItemType", "operationId": "get_billing_itemtype_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all BillingItemType", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BillingItemType" } } } } } } } }, "\/api\/invoice\/offeraccountingtypes": { "get": { "tags": [ "Billing \/ OfferAccountingType" ], "summary": "Returns a list of all OfferAccountingType", "operationId": "get_offer_accounting_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all OfferAccountingType", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferAccountingType" } } } } } } }, "post": { "tags": [ "Billing \/ OfferAccountingType" ], "summary": "Add a new OfferAccountingType", "operationId": "post_post_offer_accounting", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OfferAccountingType" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new OfferAccountingType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OfferAccountingType" } } } } } } }, "\/api\/invoice\/offeraccountingtypes\/{identifier}": { "get": { "tags": [ "Billing \/ OfferAccountingType" ], "summary": "Get a single OfferAccountingType", "operationId": "get_get_offer_accounting", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single OfferAccountingType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OfferAccountingType" } } } } } }, "put": { "tags": [ "Billing \/ OfferAccountingType" ], "summary": "Update an OfferAccountingType", "operationId": "put_put_offer_accounting", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OfferAccountingType" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an OfferAccountingType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OfferAccountingType" } } } } } } }, "\/api\/invoice\/projecttimereports\/{id}": { "get": { "tags": [ "Billing \/ ProjectTimeReport" ], "summary": "This method will get a single ProjectTimeReport Object with the given id", "operationId": "get_get_projecttimereport", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single ProjectTimeReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProjectTimeReport2" } } } } } } }, "\/api\/invoice\/projecttimereports": { "get": { "tags": [ "Billing \/ ProjectTimeReport" ], "summary": "This method will get all ProjectTimeReport Objects", "operationId": "get_get_projecttimereports", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "invoice", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "timeBilledOnTicketClose", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "start", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "timeStringBillable", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "timeStringNotBillable", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of ProjectTimeReport objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ProjectTimeReport3" } } } } } } } }, "\/api\/invoice\/projecttimereports\/{id}\/pdf": { "get": { "tags": [ "Billing \/ ProjectTimeReport" ], "summary": "This method will print a ProjectTimeReport as PDF", "operationId": "get_get_projecttimereport_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/donation_goal": { "get": { "tags": [ "Billing \/ DonationGoal" ], "summary": "List all donation goals", "operationId": "get_cget_donation_goal", "responses": { "200": { "description": "Returns a list of DonationGoals" } } }, "post": { "tags": [ "Billing \/ DonationGoal" ], "summary": "Create a new donation goal", "operationId": "post_post_donation_goal", "responses": { "200": { "description": "Creates a new DonationGoal" } } } }, "\/api\/invoice\/donation_goal\/{id}\/progress": { "get": { "tags": [ "Billing \/ DonationGoal" ], "summary": "Fortschritt eines Spendenziels: Zielbetrag, gesammelt, Anzahl Spender, Enddatum (U1).", "description": "Setting donation_goal_progress_enabled.", "operationId": "get_get_donation_goal_progress", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "targetAmount, endDate, collected, donorCount, percent, ended" }, "404": { "description": "Ohne Setting oder unbekanntes Ziel" } } } }, "\/api\/invoice\/donation_goal\/{id}": { "get": { "tags": [ "Billing \/ DonationGoal" ], "summary": "Get a single donation goal", "operationId": "get_get_donation_goal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single DonationGoal" } } }, "put": { "tags": [ "Billing \/ DonationGoal" ], "summary": "Update a donation goal", "operationId": "put_put_donation_goal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates a DonationGoal" } } }, "delete": { "tags": [ "Billing \/ DonationGoal" ], "summary": "Delete a donation goal (soft delete)", "operationId": "delete_delete_donation_goal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a DonationGoal" } } }, "patch": { "tags": [ "Billing \/ DonationGoal" ], "summary": "Update a donation goal", "operationId": "patch_put_donation_goal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates a DonationGoal" } } } }, "\/api\/invoice\/donation\/report": { "get": { "tags": [ "Billing \/ Donation" ], "summary": "Auswertung der Spenden (V1): abgeschlossene Spenden im Zeitraum, gesamt, nur Geld, je\nSpendenziel, je Monat und je Zahlart. Vorgabe ist das laufende Jahr. Setting\ndonation_report_enabled. Die Buchungsliste dazu ist der Export iw-export-donation-bookings.", "operationId": "get_get_donation_report", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Summen und Anzahl je Ziel, Monat und Zahlart" }, "400": { "description": "Ung\u00fcltiger Zeitraum" } } } }, "\/api\/invoice\/donation": { "get": { "tags": [ "Billing \/ Donation" ], "summary": "List all donations", "operationId": "get_cget_donation", "responses": { "200": { "description": "Returns a list of Donations" } } }, "post": { "tags": [ "Billing \/ Donation" ], "summary": "Create a new donation (admin)", "operationId": "post_post_donation", "responses": { "200": { "description": "Creates a new Donation" } } } }, "\/api\/invoice\/donation\/{id}": { "get": { "tags": [ "Billing \/ Donation" ], "summary": "Get a single donation", "operationId": "get_get_donation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single Donation" } } }, "put": { "tags": [ "Billing \/ Donation" ], "summary": "Update a donation (limited fields: status, address, person\/company link)", "operationId": "put_put_donation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates a Donation" } } }, "patch": { "tags": [ "Billing \/ Donation" ], "summary": "Update a donation (limited fields: status, address, person\/company link)", "operationId": "patch_put_donation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates a Donation" } } } }, "\/api\/invoice\/donation\/{id}\/pdf": { "get": { "tags": [ "Billing \/ Donation" ], "summary": "Download Spendenbescheinigung PDF", "operationId": "get_get_donation_pdf", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the Spendenbescheinigung as PDF" } } } }, "\/api\/invoice\/donation\/{id}\/sepa_return": { "post": { "tags": [ "Billing \/ Donation" ], "summary": "R\u00fccklastschrift einer per SEPA eingezogenen Spende von Hand erfassen.", "description": "F\u00fcr R\u00fccklastschriften, die der Bankabgleich nicht selbst zuordnen kann (Kontoauszug ohne\nReferenz, Mitteilung der Bank per Brief). Die Spende wird storniert, eine Dauerspende nach\nmehreren R\u00fccklastschriften in Folge pausiert. Setting donation_sepa_return_enabled.", "operationId": "post_post_donation_sepa_return", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "reason": { "description": "R\u00fcckgabegrund, z. B. AC04 oder MD06", "type": "string" }, "fee": { "description": "Bankentgelt der R\u00fccklastschrift", "type": "number" } }, "type": "object" } } } }, "responses": { "200": { "description": "Die stornierte Spende" }, "409": { "description": "Die Spende wurde nicht per SEPA eingezogen oder der Einzug ging noch nicht an die Bank" } } } }, "\/api\/invoice\/donation\/reassign\/suggestions": { "get": { "tags": [ "Billing \/ Donation" ], "summary": "Spenden ohne Person, die mit einer Mailadresse der Person gegeben wurden.", "description": "F\u00fcr das Zuordnen von Gast-Spenden zu einem Mitglied (V5). Setting donation_reassign_enabled.", "operationId": "get_get_donation_reassign_suggestions", "parameters": [ { "name": "crmPerson", "in": "query", "description": "Die Person, f\u00fcr die gesucht wird", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "\\d+" } } ], "responses": { "200": { "description": "Die Mailadressen der Person, passende Spenden und Dauerspenden" }, "404": { "description": "Funktion nicht aktiviert oder Person nicht gefunden" } } } }, "\/api\/invoice\/donation\/reassign": { "post": { "tags": [ "Billing \/ Donation" ], "summary": "Spenden und Dauerspenden einer anderen Person oder einem anderen Haushalt zuordnen.", "description": "Gast-Spenden einem Mitglied zuordnen oder die Spenden einer doppelt angelegten Person\nzusammenf\u00fchren (V5). Ohne Haushalt gilt der einzige Haushalt der Person. Eine Spende mit\nausgestellter Zuwendungsbest\u00e4tigung bleibt beim Spender, bis die Best\u00e4tigung storniert ist;\ndann wird keine der Spenden ge\u00e4ndert. Setting donation_reassign_enabled.", "operationId": "post_post_donation_reassign", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "donations": { "description": "IDs der Spenden", "type": "array", "items": { "type": "integer" } }, "recurringDonations": { "description": "IDs der Dauerspenden", "type": "array", "items": { "type": "integer" } }, "crmPerson": { "description": "Neue Person", "type": "integer" }, "crmCompany": { "description": "Neuer Haushalt", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Anzahl der zugeordneten Spenden und Dauerspenden" }, "409": { "description": "Eine Spende ist bereits best\u00e4tigt" } } } }, "\/api\/invoice\/donation\/collective_receipt\/candidates": { "get": { "tags": [ "Billing \/ Donation" ], "summary": "Die Arbeitsliste f\u00fcr die Sammelbest\u00e4tigungen eines Jahres.", "description": "Wer im Jahr mehrfach gespendet hat, bekommt eine Best\u00e4tigung statt\nzw\u00f6lf. Diese Liste sagt, f\u00fcr wen sich das lohnt - mit Anzahl und Summe,\ndamit vor dem Erzeugen erkennbar ist, worum es geht.\n\nVoran stehen die Stammdaten: fehlen Finanzamt oder Bescheiddatum, ist\njede Best\u00e4tigung angreifbar, und das f\u00e4llt erst beim Spender auf.", "operationId": "get_get_donation_collective_receipt_candidates", "parameters": [ { "name": "year", "in": "query", "description": "Kalenderjahr, Vorgabe das vergangene", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}" } }, { "name": "minimum", "in": "query", "description": "Ab wie vielen Zuwendungen, Vorgabe 2", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d+" } } ], "responses": { "200": { "description": "Zuwendende mit mehreren Spenden im Jahr" } } } }, "\/api\/invoice\/donation\/in_kind": { "post": { "tags": [ "Billing \/ Donation" ], "summary": "Sachspende erfassen (S4).", "description": "Die Felder einer Spende wie beim Anlegen, amount ist der Wert der Sachspende. Dazu inKind mit\nder genauen Bezeichnung, der Herkunft (private, business, unknown), ob Unterlagen zur\nWertermittlung vorliegen und der Bewertungsgrundlage. Die Spende ist sofort abgeschlossen:\nsie kommt nicht \u00fcber das Konto. Setting donation_in_kind_enabled.", "operationId": "post_post_donation_in_kind", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "amount": { "description": "Wert der Sachspende", "type": "number" }, "donorName": { "type": "string" }, "inKind": { "properties": { "description": { "description": "Bezeichnung mit Alter, Zustand, Kaufpreis", "type": "string" }, "origin": { "type": "string", "enum": [ "private", "business", "unknown" ] }, "documents": { "description": "Unterlagen zur Wertermittlung liegen vor", "type": "boolean" }, "valuationBasis": { "description": "z. B. Rechnung vom 03.02.2026", "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Die Sachspende" }, "400": { "description": "Angaben zur Sachspende fehlen" } } } }, "\/api\/invoice\/donation\/{id}\/in_kind": { "put": { "tags": [ "Billing \/ Donation" ], "summary": "Angaben einer Sachspende korrigieren (S4): Wert und inKind wie beim Erfassen. Nach dem\nAusstellen der Best\u00e4tigung erst nach deren Storno.", "operationId": "put_put_donation_in_kind", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Die Sachspende" }, "409": { "description": "Die Best\u00e4tigung ist ausgestellt" } } }, "patch": { "tags": [ "Billing \/ Donation" ], "summary": "Angaben einer Sachspende korrigieren (S4): Wert und inKind wie beim Erfassen. Nach dem\nAusstellen der Best\u00e4tigung erst nach deren Storno.", "operationId": "patch_put_donation_in_kind", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Die Sachspende" }, "409": { "description": "Die Best\u00e4tigung ist ausgestellt" } } } }, "\/api\/invoice\/donation\/collective_receipt\/run": { "post": { "tags": [ "Billing \/ Donation" ], "summary": "Sammelbest\u00e4tigungen eines Jahres als Massenlauf.", "description": "Der Testlauf (dryRun) zeigt nur, wer eine bekommt. Der echte Lauf stellt sie aus und schickt\nsie mit sendMail per Mail mit dem PDF im Anhang. Wer f\u00fcr das Jahr schon eine hat, bleibt\ndrau\u00dfen, ebenso wer unter der Mindestsumme donation_collective_receipt_min_total liegt.\nSetting donation_collective_receipt_bulk_enabled (S7).", "operationId": "post_post_donation_collective_receipt_run", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "year": { "description": "Kalenderjahr, Vorgabe das vergangene", "type": "integer" }, "minimum": { "description": "Ab wie vielen Zuwendungen, Vorgabe 2", "type": "integer" }, "dryRun": { "description": "Nur anzeigen, Vorgabe true", "type": "boolean" }, "sendMail": { "description": "Per Mail verschicken, Vorgabe true", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Ergebnis je Zuwendendem und Zusammenfassung" }, "409": { "description": "Angaben zum Freistellungsbescheid fehlen oder Best\u00e4tigungen werden nicht protokolliert" } } } }, "\/api\/invoice\/donation\/collective_receipt\/{id}\/pdf": { "get": { "tags": [ "Billing \/ Donation" ], "summary": "Die Sammelbest\u00e4tigung eines Zuwendenden als PDF.", "operationId": "get_get_donation_collective_receipt", "parameters": [ { "name": "year", "in": "query", "description": "Kalenderjahr, Vorgabe das vergangene", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}" } }, { "name": "donor_type", "in": "query", "description": "person oder company, Vorgabe person", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "preview", "in": "query", "description": "1 = Entwurf zum Testlauf, wird weder ausgestellt noch protokolliert (Setting donation_collective_receipt_bulk_enabled)", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Die Sammelbest\u00e4tigung als PDF" } } } }, "\/api\/invoice\/donation_receipt": { "get": { "tags": [ "Billing \/ Donation Receipt" ], "summary": "Ausgestellte Zuwendungsbest\u00e4tigungen", "operationId": "get_cget_donation_receipt", "responses": { "200": { "description": "Returns a list of issued DonationReceipts" } } } }, "\/api\/invoice\/donation_receipt\/{id}": { "get": { "tags": [ "Billing \/ Donation Receipt" ], "summary": "Eine ausgestellte Zuwendungsbest\u00e4tigung mit ihren Spenden", "operationId": "get_get_donation_receipt", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single DonationReceipt" } } } }, "\/api\/invoice\/donation_receipt\/{id}\/cancel": { "post": { "tags": [ "Billing \/ Donation Receipt" ], "summary": "Zuwendungsbest\u00e4tigung stornieren", "description": "Danach lassen sich die Spenden wieder \u00e4ndern und neu best\u00e4tigen; die neue Best\u00e4tigung verweist\nauf die stornierte.", "operationId": "post_post_donation_receipt_cancel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "reason": { "description": "Grund des Stornos", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The canceled DonationReceipt" }, "409": { "description": "Already canceled or no reason given" } } } }, "\/api\/invoice\/recurring_donation": { "get": { "tags": [ "Billing \/ RecurringDonation" ], "summary": "List all recurring donations", "operationId": "get_cget_recurring_donation", "responses": { "200": { "description": "Returns a list of RecurringDonations" } } } }, "\/api\/invoice\/recurring_donation\/{id}": { "get": { "tags": [ "Billing \/ RecurringDonation" ], "summary": "Get a single recurring donation", "operationId": "get_get_recurring_donation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single RecurringDonation" } } }, "put": { "tags": [ "Billing \/ RecurringDonation" ], "summary": "Update a recurring donation", "operationId": "put_put_recurring_donation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates a RecurringDonation" } } }, "patch": { "tags": [ "Billing \/ RecurringDonation" ], "summary": "Update a recurring donation", "operationId": "patch_put_recurring_donation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates a RecurringDonation" } } } }, "\/api\/invoice\/recurring_donation\/execute": { "post": { "tags": [ "Billing \/ RecurringDonation" ], "summary": "Execute all due recurring donations now (manual run)", "description": "Creates the per-cycle Donation + SEPA collection transaction for every recurring donation that\nis due, using the same logic as the scheduled cron command. Returns a small summary of the run.", "operationId": "post_post_recurring_donation_execute", "responses": { "200": { "description": "Runs the due recurring donations and returns a summary" } } } }, "\/api\/invoice\/recurring_donation\/export\/sepa_names": { "get": { "tags": [ "Billing \/ RecurringDonation" ], "summary": "List the run\/batch names of donation SEPA collections that have not been exported yet", "description": "Lets the UI offer a \"which run to export\" selection for the recurring donation SEPA export.", "operationId": "get_get_recurring_donation_export_sepa_names", "responses": { "200": { "description": "Returns the distinct un-exported donation SEPA run names" } } } }, "\/api\/invoice\/recurring_donation\/{id}\/cancel": { "post": { "tags": [ "Billing \/ RecurringDonation" ], "summary": "Cancel a recurring donation", "operationId": "post_cancel_recurring_donation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Cancels a RecurringDonation" } } } }, "\/api\/invoice\/external\/donation\/amounts": { "get": { "tags": [ "Billing \/ DonationExternal" ], "summary": "Get available donation amounts and feature status", "operationId": "get_get_donation_external_amounts", "responses": { "200": { "description": "Returns available donation amounts" } } } }, "\/api\/invoice\/external\/donation\/initiate": { "post": { "tags": [ "Billing \/ DonationExternal" ], "summary": "Initiate a donation with payment", "operationId": "post_post_donation_external_initiate", "responses": { "200": { "description": "Creates a donation and returns payment redirect URL" } } } }, "\/api\/invoice\/external\/donation\/notify\/{token}\/{paymentProvider}": { "get": { "tags": [ "Billing \/ DonationExternal" ], "summary": "Payment gateway notification callback", "operationId": "get_get_donation_external_notification", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "paymentProvider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Processes payment notification" } } }, "post": { "tags": [ "Billing \/ DonationExternal" ], "summary": "Payment gateway notification callback", "operationId": "post_get_donation_external_notification", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "paymentProvider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Processes payment notification" } } } }, "\/api\/invoice\/external\/donation\/pdf\/{id}\/{token}": { "get": { "tags": [ "Billing \/ DonationExternal" ], "summary": "Download Spendenbescheinigung PDF by token", "operationId": "get_get_donation_external_pdf", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the Spendenbescheinigung as PDF" } } } }, "\/api\/invoice\/external\/donation\/recurring\/initiate": { "post": { "tags": [ "Billing \/ DonationExternal" ], "summary": "Initiate a recurring donation collected via SEPA direct debit.", "operationId": "post_post_donation_external_recurring_initiate", "responses": { "200": { "description": "Creates a recurring donation with a SEPA mandate" } } } }, "\/api\/invoice\/external\/donation\/recurring\/{token}": { "get": { "tags": [ "Billing \/ DonationExternal" ], "summary": "Get recurring donation status by token", "operationId": "get_get_donation_external_recurring", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns recurring donation status" } } } }, "\/api\/invoice\/external\/donation\/recurring\/{token}\/cancel": { "post": { "tags": [ "Billing \/ DonationExternal" ], "summary": "Cancel a recurring donation by token", "operationId": "post_post_donation_external_recurring_cancel", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cancels a recurring donation" } } } }, "\/api\/invoice\/external\/donation\/{token}": { "get": { "tags": [ "Billing \/ DonationExternal" ], "summary": "Get donation status by token", "operationId": "get_get_donation_external", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns donation status" } } } }, "\/api\/invoice\/voucher\/expired": { "get": { "tags": [ "Billing \/ Voucher" ], "summary": "Returns the expired entries.", "operationId": "get_cget_voucher_expired", "responses": { "200": { "description": "Paid vouchers with a balance after their validity ended (setting voucher_expiry_write_off_enabled)" } } } }, "\/api\/invoice\/voucher\/from_invoice": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Creates a new entry from an invoice.", "operationId": "post_post_voucher_from_invoice", "responses": { "200": { "description": "Refunds a paid invoice as a voucher (setting voucher_refund_enabled)" } } } }, "\/api\/invoice\/voucher\/bulk": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Creates several records in one request.", "operationId": "post_post_voucher_bulk", "responses": { "200": { "description": "Creates a batch of vouchers (setting voucher_bulk_enabled)" } } } }, "\/api\/invoice\/voucher\/batch\/{batchId}.csv": { "get": { "tags": [ "Billing \/ Voucher" ], "summary": "Returns a batch as CSV.", "operationId": "get_get_voucher_batch_csv", "parameters": [ { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-f0-9]+" } } ], "responses": { "200": { "description": "The vouchers of a batch as CSV (setting voucher_bulk_enabled)" } } } }, "\/api\/invoice\/voucher\/{id}\/send_mail": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Sends an e-mail.", "operationId": "post_post_voucher_send_mail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sends the voucher PDF by mail (again) (setting voucher_bulk_enabled)" } } } }, "\/api\/invoice\/voucher": { "get": { "tags": [ "Billing \/ Voucher" ], "summary": "Returns a list of voucher entries.", "operationId": "get_cget_voucher", "responses": { "200": { "description": "Returns a list of Vouchers" } } }, "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Creates a new voucher entry.", "operationId": "post_post_voucher", "responses": { "200": { "description": "Creates a new Voucher" } } } }, "\/api\/invoice\/voucher\/{id}": { "get": { "tags": [ "Billing \/ Voucher" ], "summary": "Returns a single voucher entry.", "operationId": "get_get_voucher", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single Voucher" } } }, "put": { "tags": [ "Billing \/ Voucher" ], "summary": "Updates an existing voucher entry.", "operationId": "put_put_voucher", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates a Voucher" } } }, "patch": { "tags": [ "Billing \/ Voucher" ], "summary": "Updates an existing voucher entry.", "operationId": "patch_put_voucher", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates a Voucher" } } } }, "\/api\/invoice\/voucher\/{id}\/pdf": { "get": { "tags": [ "Billing \/ Voucher" ], "summary": "Returns the PDF document.", "operationId": "get_get_voucher_pdf", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns the Voucher as PDF" } } } }, "\/api\/invoice\/voucher\/{id}\/redeem": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Redeems a code or voucher.", "operationId": "post_post_voucher_redeem", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Redeems amount from voucher" } } } }, "\/api\/invoice\/voucher\/{id}\/mark_paid": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Marks the entry as paid.", "operationId": "post_post_voucher_mark_paid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Marks voucher as paid" } } } }, "\/api\/invoice\/voucher\/{id}\/cancel": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Cancels the entry.", "operationId": "post_post_voucher_cancel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cancels a voucher" } } } }, "\/api\/invoice\/voucher\/{id}\/import_credit": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Imports credit.", "operationId": "post_post_voucher_import_credit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Imports voucher balance as company credit" } } } }, "\/api\/invoice\/voucher\/{id}\/pay_invoice": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Pays an invoice.", "operationId": "post_post_voucher_pay_invoice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pays an invoice with voucher balance" } } } }, "\/api\/invoice\/voucher\/{id}\/block": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Blocks the entry.", "operationId": "post_post_voucher_block", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Blocks a voucher (setting voucher_block_enabled)" } } } }, "\/api\/invoice\/voucher\/{id}\/unblock": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Unblocks the entry.", "operationId": "post_post_voucher_unblock", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Unblocks a voucher (setting voucher_block_enabled)" } } } }, "\/api\/invoice\/voucher\/{id}\/write_off": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Writes off the open amount.", "operationId": "post_post_voucher_write_off", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Writes off the balance of an expired voucher (setting voucher_expiry_write_off_enabled)" } } } }, "\/api\/invoice\/voucher\/{id}\/transactions\/{transactionId}\/reverse": { "post": { "tags": [ "Billing \/ Voucher" ], "summary": "Reverses the entry.", "operationId": "post_post_voucher_transaction_reverse", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Reverses a booking of the voucher (setting voucher_reversal_enabled)" } } } }, "\/api\/invoice\/voucher\/{id}\/transactions": { "get": { "tags": [ "Billing \/ Voucher" ], "summary": "Returns the transactions.", "operationId": "get_get_voucher_transactions", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns transactions for a voucher" } } } }, "\/api\/invoice\/external\/voucher\/config": { "get": { "tags": [ "Billing \/ VoucherExternal" ], "summary": "Returns the configuration.", "operationId": "get_get_voucher_external_config", "responses": { "200": { "description": "Returns voucher configuration for public purchase" } } } }, "\/api\/invoice\/external\/voucher\/purchase": { "post": { "tags": [ "Billing \/ VoucherExternal" ], "summary": "Purchases an item.", "operationId": "post_post_voucher_external_purchase", "responses": { "200": { "description": "Creates a voucher and returns payment redirect URL" } } } }, "\/api\/invoice\/external\/voucher\/balance\/{code}": { "get": { "tags": [ "Billing \/ VoucherExternal" ], "summary": "Returns the current balance.", "operationId": "get_get_voucher_external_balance", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Balance of a voucher by its code (setting voucher_balance_check_enabled)" } } } }, "\/api\/invoice\/external\/voucher\/redeem_credit": { "post": { "tags": [ "Billing \/ VoucherExternal" ], "summary": "Redeems credit.", "operationId": "post_post_voucher_external_redeem_credit", "responses": { "200": { "description": "Loads the balance of a voucher code onto the credit of the logged-in customer (setting voucher_customer_credit_enabled)" } } } }, "\/api\/invoice\/external\/voucher\/pdf\/{id}\/{token}": { "get": { "tags": [ "Billing \/ VoucherExternal" ], "summary": "Returns the PDF document.", "operationId": "get_get_voucher_external_pdf", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the Voucher as PDF" } } } }, "\/api\/invoice\/external\/voucher\/{token}": { "get": { "tags": [ "Billing \/ VoucherExternal" ], "summary": "Returns a single voucher external entry.", "operationId": "get_get_voucher_external", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns voucher status" } } } }, "\/api\/invoice\/export\/direct_debit\/invoices": { "get": { "tags": [ "Billing \/ InvoicePayment" ], "summary": "Export selected invoices", "operationId": "get_invoice_payment_export_direct_debit", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "head": { "tags": [ "Billing \/ InvoicePayment" ], "summary": "Export selected invoices", "operationId": "head_invoice_payment_export_direct_debit", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/export\/direct_debit\/sepa_execution_names": { "get": { "tags": [ "Billing \/ InvoicePayment" ], "summary": "Export names of sepa execution", "operationId": "get_invoice_payment_export_sepa_execution_names", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/sepa_payment_transaction\/execution_names": { "get": { "tags": [ "Billing \/ SepaPaymentTransaction" ], "summary": "Returns the names of the generated sepa exports together with the numbers needed to pick\none: how many transactions it holds, what they add up to and when it was generated. This is\nthe first step of the review - a name is picked here and passed to the list endpoint.", "operationId": "get_sepa_payment_transaction_execution_names", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "payment_profile", "in": "query", "description": "billing payment profile of the generated sepa exports", "schema": { "type": "integer" } }, { "name": "searchString", "in": "query", "description": "filter the names by a substring", "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/sepa_payment_transaction\/warnings": { "get": { "tags": [ "Billing \/ SepaPaymentTransaction" ], "summary": "Returns the duplicate warnings of one generated sepa export: the groups of transactions that\ndebit the same value from the same payment owner or from the same iban, together with the\ntotals of the export. Computed over the whole export, independent of list pagination.", "operationId": "get_sepa_payment_transaction_warnings", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "name", "in": "query", "description": "name of the generated sepa export", "required": true, "schema": { "type": "string" } }, { "name": "payment_profile", "in": "query", "description": "billing payment profile of the generated sepa export", "schema": { "type": "integer" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/sepa_payment_transaction": { "get": { "tags": [ "Billing \/ SepaPaymentTransaction" ], "summary": "Returns the transactions of one generated sepa export. The export is selected by its name,\nso `name` is required - without it the endpoint would return every transaction ever\ngenerated. Each row carries the duplicate warning flags for the whole export, and\n`duplicates` restricts the list to the flagged rows.", "operationId": "get_sepa_payment_transaction_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "auto", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "incoming", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "billingPaymentProfile", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bruttoValue", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "currency", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "paymentOwner", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "paymentIban", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "paymentBic", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "paymentMandate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the transactions of one generated sepa export", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SepaPaymentTransaction" } } } } } } } }, "\/api\/invoice\/payment_transaction": { "get": { "tags": [ "Billing \/ PaymentTransaction" ], "summary": "Returns a list of all PaymentTransaction", "operationId": "get_payment_transaction_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all PaymentTransaction", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PaymentTransaction" } } } } } } }, "post": { "tags": [ "Billing \/ PaymentTransaction" ], "summary": "Add a new PaymentTransaction", "operationId": "post_payment_transaction_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PaymentTransaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new PaymentTransaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentTransaction2" } } } } } } }, "\/api\/invoice\/payment_transaction\/{identifier}": { "get": { "tags": [ "Billing \/ PaymentTransaction" ], "summary": "Get a single PaymentTransaction", "operationId": "get_payment_transaction_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single PaymentTransaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentTransaction2" } } } } } }, "put": { "tags": [ "Billing \/ PaymentTransaction" ], "summary": "Update a PaymentTransaction", "operationId": "put_payment_transaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PaymentTransaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a PaymentTransaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentTransaction2" } } } } } } }, "\/api\/invoice\/multi_payment_transaction": { "post": { "tags": [ "Billing \/ PaymentTransaction" ], "summary": "Add a new PaymentTransactions for multiple company ids", "operationId": "post_payment_transaction_post_multi", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add new PaymentTransactions for multiple company ids", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentTransaction2" } } } } } } }, "\/api\/invoice\/incoming_invoice_transaction": { "get": { "tags": [ "Billing \/ IncomingInvoiceTransaction" ], "summary": "Returns a list of all IncomingInvoiceTransaction entries.", "operationId": "get_incoming_invoice_transaction_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "incomingInvoice", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "amount", "in": "query", "description": "Positiver Betrag dieser konkreten Zahlung. | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "paymentDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "buchhaltungsButlerTransactionId", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all IncomingInvoiceTransaction entries", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IncomingInvoiceTransaction" } } } } } } }, "post": { "tags": [ "Billing \/ IncomingInvoiceTransaction" ], "summary": "Add an IncomingInvoiceTransaction.", "operationId": "post_incoming_invoice_transaction_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/IncomingInvoiceTransaction" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add an IncomingInvoiceTransaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoiceTransaction" } } } } } } }, "\/api\/invoice\/incoming_invoice_transaction\/{identifier}": { "get": { "tags": [ "Billing \/ IncomingInvoiceTransaction" ], "summary": "Get a single IncomingInvoiceTransaction.", "operationId": "get_incoming_invoice_transaction_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single IncomingInvoiceTransaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoiceTransaction" } } } } } }, "put": { "tags": [ "Billing \/ IncomingInvoiceTransaction" ], "summary": "Update an IncomingInvoiceTransaction.", "operationId": "put_incoming_invoice_transaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/IncomingInvoiceTransaction" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an IncomingInvoiceTransaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoiceTransaction" } } } } } } }, "\/api\/invoice\/imported_payment_transaction": { "get": { "tags": [ "Billing \/ ImportedPaymentTransaction" ], "summary": "Returns a list of all ImportedPaymentTransaction", "operationId": "get_imported_payment_transaction_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all ImportedPaymentTransaction", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ImportedPaymentTransaction" } } } } } } }, "post": { "tags": [ "Billing \/ ImportedPaymentTransaction" ], "summary": "Add a new ImportedPaymentTransaction", "operationId": "post_imported_payment_transaction_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ImportedPaymentTransaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ImportedPaymentTransaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ImportedPaymentTransaction2" } } } } } } }, "\/api\/invoice\/imported_payment_transaction\/{identifier}": { "get": { "tags": [ "Billing \/ ImportedPaymentTransaction" ], "summary": "Get a single ImportedPaymentTransaction", "operationId": "get_imported_payment_transaction_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single ImportedPaymentTransaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ImportedPaymentTransaction2" } } } } } }, "put": { "tags": [ "Billing \/ ImportedPaymentTransaction" ], "summary": "Update a ImportedPaymentTransaction", "operationId": "put_imported_payment_transaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ImportedPaymentTransaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a ImportedPaymentTransaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ImportedPaymentTransaction2" } } } } } } }, "\/api\/invoice\/imported_payment_transaction\/{identifier}\/unlink": { "post": { "tags": [ "Billing \/ ImportedPaymentTransaction" ], "summary": "Unlink an ImportedPaymentTransaction so the amount can be re-assigned.", "description": "Reverts auto-generated payment transactions, re-opens linked invoices and restores consumed\nSEPA transactions. Query params: keep_company (bool, default false) keeps the linked company,\nrelink (bool, default false) lets the auto-link process pick the transaction up again,\nmode (\"revert\" default, or \"storno\" to neutralize with counter bookings instead of deleting -\nrequired for transactions already exported to the accounting software or in closed periods).", "operationId": "post_imported_payment_transaction_unlink", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Unlink an ImportedPaymentTransaction so the amount can be re-assigned", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ImportedPaymentTransaction2" } } } } } } }, "\/api\/invoice\/imported_payment_transaction_group": { "get": { "tags": [ "Billing \/ ImportedPaymentTransactionGroup" ], "summary": "Returns a list of all ImportedPaymentTransactionGroup", "operationId": "get_imported_payment_transaction_group_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all ImportedPaymentTransactionGroup", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ImportedPaymentTransactionGroup" } } } } } } }, "post": { "tags": [ "Billing \/ ImportedPaymentTransactionGroup" ], "summary": "Add a new ImportedPaymentTransactionGroup", "operationId": "post_imported_payment_transaction_group_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ImportedPaymentTransactionGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ImportedPaymentTransactionGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ImportedPaymentTransactionGroup2" } } } } } } }, "\/api\/invoice\/imported_payment_transaction_group\/{identifier}": { "get": { "tags": [ "Billing \/ ImportedPaymentTransactionGroup" ], "summary": "Get a single ImportedPaymentTransactionGroup", "operationId": "get_imported_payment_transaction_group_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single ImportedPaymentTransactionGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ImportedPaymentTransactionGroup2" } } } } } }, "put": { "tags": [ "Billing \/ ImportedPaymentTransactionGroup" ], "summary": "Update a ImportedPaymentTransactionGroup", "operationId": "put_imported_payment_transaction_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ImportedPaymentTransactionGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a ImportedPaymentTransactionGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ImportedPaymentTransactionGroup2" } } } } } } }, "\/api\/invoice\/incoming_invoice": { "get": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Returns a list of all IncomingInvoice", "operationId": "get_incoming_invoice_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all IncomingInvoice", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IncomingInvoice" } } } } } } }, "post": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Import an IncomingInvoice from file upload (ZUGFeRD PDF\/XML or regular PDF)", "operationId": "post_incoming_invoice_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "properties": { "data[file]": { "description": "Invoice file (PDF or XML)", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "Import IncomingInvoice from file", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoice" } } } } } } }, "\/api\/invoice\/incoming_invoice\/{identifier}": { "get": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Get a single IncomingInvoice", "operationId": "get_incoming_invoice_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single IncomingInvoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoice" } } } } } }, "put": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Update an IncomingInvoice", "operationId": "put_incoming_invoice_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/IncomingInvoice" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an IncomingInvoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoice" } } } } } }, "delete": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Delete an IncomingInvoice (soft delete - archive)", "operationId": "delete_incoming_invoice_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete an IncomingInvoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoice" } } } } } } }, "\/api\/invoice\/incoming_invoice\/archive": { "post": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Import all PDF\/XML invoices from a ZIP archive.", "operationId": "post_incoming_invoice_archive_post", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Import IncomingInvoices from a ZIP archive", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/IncomingInvoice" } } } } } } } }, "\/api\/invoice\/incoming_invoice\/{identifier}\/approve": { "post": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Mark an IncomingInvoice as approved", "operationId": "post_incoming_invoice_approve", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Approve an IncomingInvoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoice" } } } } } } }, "\/api\/invoice\/incoming_invoice\/{identifier}\/ai_category": { "post": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Ask the AI decision model for a booking suggestion (expense category, VAT case).", "description": "Opt-in (inwendo_invoice_ai_expense_category_enabled). The category is only pre-filled when\nthe invoice has none and the probability reaches the threshold; the VAT case stays a hint.\nNothing is approved or posted.", "operationId": "post_incoming_invoice_ai_category", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AI booking suggestion for an IncomingInvoice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoice" } } } } } } }, "\/api\/invoice\/incoming_invoice\/{identifier}\/paid": { "post": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Mark an IncomingInvoice as paid", "operationId": "post_incoming_invoice_paid", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "paidValue": { "description": "Defaults to the invoice total", "type": "number", "example": 119 }, "paymentDate": { "description": "Defaults to today", "type": "string", "example": "2026-07-30" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Mark IncomingInvoice as paid", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoice" } } } } } } }, "\/api\/invoice\/incoming_invoice\/{identifier}\/buchhaltungsbutler_push": { "post": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Push an IncomingInvoice to BuchhaltungsButler (manual transfer \/ re-transfer)", "operationId": "post_incoming_invoice_buchhaltungsbutler_push", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Push an IncomingInvoice to BuchhaltungsButler", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/IncomingInvoice" } } } } } } }, "\/api\/invoice\/incoming_invoice\/{identifier}\/document": { "get": { "tags": [ "Billing \/ IncomingInvoice" ], "summary": "Download the document file of an IncomingInvoice", "operationId": "get_incoming_invoice_document", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the document file" } } } }, "\/api\/invoice\/expense_category": { "get": { "tags": [ "Billing \/ ExpenseCategory" ], "summary": "Returns a list of all ExpenseCategory", "operationId": "get_expense_category_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all ExpenseCategory", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ExpenseCategory" } } } } } } }, "post": { "tags": [ "Billing \/ ExpenseCategory" ], "summary": "Add a new ExpenseCategory", "operationId": "post_expense_category_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ExpenseCategory" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ExpenseCategory", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExpenseCategory" } } } } } } }, "\/api\/invoice\/expense_category\/tree": { "get": { "tags": [ "Billing \/ ExpenseCategory" ], "summary": "Get category tree structure", "operationId": "get_expense_category_tree", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/expense_category\/{identifier}": { "get": { "tags": [ "Billing \/ ExpenseCategory" ], "summary": "Get a single ExpenseCategory", "operationId": "get_expense_category_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single ExpenseCategory", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExpenseCategory" } } } } } }, "put": { "tags": [ "Billing \/ ExpenseCategory" ], "summary": "Update an ExpenseCategory", "operationId": "put_expense_category_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ExpenseCategory" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an ExpenseCategory", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExpenseCategory" } } } } } }, "delete": { "tags": [ "Billing \/ ExpenseCategory" ], "summary": "Delete an ExpenseCategory (soft delete)", "operationId": "delete_expense_category_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete an ExpenseCategory", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExpenseCategory" } } } } } }, "patch": { "tags": [ "Billing \/ ExpenseCategory" ], "summary": "Update an ExpenseCategory", "operationId": "patch_expense_category_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ExpenseCategory" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an ExpenseCategory", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExpenseCategory" } } } } } } }, "\/api\/invoice\/euer_report": { "get": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Returns a list of all E\u00dcR Reports", "operationId": "get_euer_report_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "fiscalYear", "in": "query", "description": "Gesch\u00e4ftsjahr | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "description": "Status des Berichts | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "accountingMethod", "in": "query", "description": "Buchhaltungsmethode (Ist oder Soll) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "periodStart", "in": "query", "description": "Berichtszeitraum Beginn | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "periodEnd", "in": "query", "description": "Berichtszeitraum Ende | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "finalizedAt", "in": "query", "description": "Datum der Finalisierung | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all E\u00dcR Reports", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EuerReport" } } } } } } } }, "\/api\/invoice\/euer_report\/statistics": { "get": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Get E\u00dcR Report statistics\/overview", "operationId": "get_euer_report_statistics", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/euer_report\/uncategorized": { "get": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Get uncategorized invoices that need category assignment", "operationId": "get_euer_report_uncategorized", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/fixed_asset": { "get": { "tags": [ "Billing \/ Anlageg\u00fcter" ], "summary": "Die Anlagegueter.", "operationId": "get_fixed_asset_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "inventoryNumber", "in": "query", "description": "Inventarnummer - frei vergeben, aber f\u00fcr die Inventur unverzichtbar. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "acquisitionDate", "in": "query", "description": "Tag der Anschaffung oder Herstellung. Bestimmt den Beginn der Abschreibung und den Zeitanteil im ersten Jahr: abgeschrieben wird ab dem Anschaffungsmonat, angefangene Monate z\u00e4hlen voll (\u00a7 7 Abs. 1 Satz 4 EStG). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "acquisitionCost", "in": "query", "description": "Anschaffungs- oder Herstellungskosten. Netto, soweit die Vorsteuer abziehbar ist. Ist sie das nicht - im ideellen Bereich eines Vereins etwa -, geh\u00f6rt sie zu den Anschaffungskosten und erh\u00f6ht damit die Bemessungsgrundlage. | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "usefulLifeMonths", "in": "query", "description": "Betriebsgew\u00f6hnliche Nutzungsdauer in Monaten. In Monaten statt in Jahren, weil die Abschreibung monatsgenau l\u00e4uft und es Nutzungsdauern unter einem Jahr gibt. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "depreciationMethod", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "ledgerAccount", "in": "query", "description": "Aktivkonto, auf dem das Gut steht - SKR04 0630 etwa. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "depreciationAccount", "in": "query", "description": "Aufwandskonto der Abschreibung - SKR04 6220 etwa. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "costCenter", "in": "query", "description": "Die steuerliche Sph\u00e4re, der das Gut dient. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "expenseCategory", "in": "query", "description": "Die E\u00dcR-Kategorie der Abschreibung. Dieselbe Br\u00fccke wie am Sachkonto: wer die E\u00dcR f\u00fchrt, bekommt seine Zeile in der Anlage E\u00dcR, ohne dass es einen Kontenrahmen br\u00e4uchte. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "incomingInvoice", "in": "query", "description": "Der Beleg, aus dem das Gut entstanden ist. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "disposalDate", "in": "query", "description": "Tag des Abgangs - Verkauf, Verschrottung, Entnahme. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "disposalTaxRate", "in": "query", "description": "Umsatzsteuersatz auf den Verkaufserl\u00f6s, in Prozent. Der Verkauf eines Anlageguts ist ein steuerpflichtiger Umsatz wie jeder andere - vorher wurde der Erl\u00f6s netto ohne Steuer gebucht, und die Umsatzsteuer fehlte in Bilanz und Voranmeldung. Bewusst ohne Vorgabewert: ob Steuer anf\u00e4llt, h\u00e4ngt am Vorgang. Eine Verschrottung, eine Entnahme und der Verkauf aus dem ideellen Bereich eines Vereins sind steuerfrei; der gewerbliche Verkauf ist es nicht. Ein geratener Satz w\u00e4re in der H\u00e4lfte der F\u00e4lle falsch. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isMovable", "in": "query", "description": "Bewegliches Wirtschaftsgut? Die degressive AfA des \u00a7 7 Abs. 2 EStG gilt nur fuer bewegliche Wirtschaftsgueter des Anlagevermoegens - ein Gebaeude oder eine Software degressiv abzuschreiben ist unzulaessig, und ohne dieses Merkmal konnte es niemand verhindern. Vorgabe true: Betriebs- und Geschaeftsausstattung ist in diesem System der Regelfall. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Anlagegueter", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FixedAsset" } } } } } } }, "post": { "tags": [ "Billing \/ Anlageg\u00fcter" ], "summary": "Legt ein Anlagegut ohne Beleg an.", "description": "Bisher entstand ein Anlagegut nur aus einer Eingangsrechnung. Das deckt\nden Regelfall ab und laesst zwei Faelle offen, die es haeufig gibt: den\nAltbestand beim Umstieg auf diese Anwendung, und die Einlage aus dem\nPrivatvermoegen. Beide haben keine Eingangsrechnung im System und waren\ndamit nicht erfassbar - in der Bilanz fehlten sie dann vollstaendig.\n\nGebucht wird dabei nichts: beim Altbestand ist der Zugang laengst in der\nEroeffnungsbilanz enthalten, und ihn ein zweites Mal zu buchen zeigte\ndas Anlagevermoegen doppelt. Der Abschreibungsplan entsteht trotzdem\nsofort - er ist der Grund, warum das Gut erfasst wird.", "operationId": "post_fixed_asset_post", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "name": { "type": "string", "example": "Notebook" }, "acquisition_date": { "type": "string", "format": "date", "example": "2026-03-01" }, "acquisition_cost": { "type": "number", "example": 1200 }, "useful_life_months": { "type": "integer", "example": 36 }, "depreciation_method": { "type": "string", "example": "linear" }, "inventory_number": { "type": "string", "example": "AV-2026-004" }, "expense_category": { "type": "integer" }, "cost_center": { "type": "integer" }, "ledger_account": { "type": "integer" }, "depreciation_account": { "type": "integer" } }, "type": "object" } } } }, "responses": { "201": { "description": "Das angelegte Anlagegut samt Abschreibungsplan" } } } }, "\/api\/invoice\/fixed_asset\/suggestions": { "get": { "tags": [ "Billing \/ Anlageg\u00fcter" ], "summary": "Nutzungsdauern und Wertgrenzen als Vorschlag f\u00fcr die Oberfl\u00e4che.", "operationId": "get_fixed_asset_suggestions", "responses": { "200": { "description": "Nutzungsdauern aus den AfA-Tabellen und die Wertgrenzen des \u00a7 6 EStG" } } } }, "\/api\/invoice\/fixed_asset\/schedule": { "get": { "tags": [ "Billing \/ Anlageg\u00fcter" ], "summary": "Der Anlagenspiegel eines Jahres.", "operationId": "get_fixed_asset_schedule", "parameters": [ { "name": "year", "in": "query", "description": "Jahr, Vorgabe das laufende", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}" } } ], "responses": { "200": { "description": "Anlagenspiegel mit Zu- und Abg\u00e4ngen, Abschreibung und Restbuchwert" } } } }, "\/api\/invoice\/fixed_asset\/from_invoice": { "post": { "tags": [ "Billing \/ Anlageg\u00fcter" ], "summary": "Legt ein Anlagegut aus einer Eingangsrechnung an.", "description": "Der Weg, den die Verbuchen-Liste anbietet: statt die Rechnung als\nAufwand zu buchen, wird sie aktiviert.", "operationId": "post_fixed_asset_from_invoice", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "incoming_invoice_id": { "type": "integer" }, "name": { "type": "string" }, "acquisition_cost": { "type": "number" }, "useful_life_months": { "type": "integer" }, "depreciation_method": { "type": "string" }, "cost_center": { "description": "Ohne Angabe die Kostenstelle der Rechnungskategorie", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Das angelegte Anlagegut samt Abschreibungsplan" } } } }, "\/api\/invoice\/fixed_asset\/depreciation_run": { "post": { "tags": [ "Billing \/ Anlageg\u00fcter" ], "summary": "Bucht die geplanten Abschreibungen eines Jahres.", "operationId": "post_fixed_asset_depreciation_run", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "year": { "type": "integer", "example": 2026 } }, "type": "object" } } } }, "responses": { "200": { "description": "Wie viele Abschreibungen gebucht wurden, und was misslang" } } } }, "\/api\/invoice\/fixed_asset\/{identifier}\/rebuild_schedule": { "post": { "tags": [ "Billing \/ Anlageg\u00fcter" ], "summary": "Berechnet den Abschreibungsplan neu.", "description": "Nach einer Korrektur der Nutzungsdauer oder der Anschaffungskosten.\nGebuchte Jahre stehen dem im Weg - die m\u00fcssten erst storniert werden.", "operationId": "post_fixed_asset_rebuild_schedule", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Das Anlagegut mit neu berechnetem Plan" } } } }, "\/api\/invoice\/fixed_asset\/{identifier}\/post_acquisition": { "post": { "tags": [ "Billing \/ Anlageg\u00fcter" ], "summary": "Bucht den Zugang.", "operationId": "post_fixed_asset_post_acquisition", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Der erzeugte Buchungssatz, oder null bei ausgeschalteter Automatik" } } } }, "\/api\/invoice\/fixed_asset\/{identifier}": { "put": { "tags": [ "Billing \/ Anlageg\u00fcter" ], "summary": "Aendert ein Anlagegut.", "description": "Anschaffungskosten, Nutzungsdauer, Methode und Datum bestimmen den\nAbschreibungsplan; wird eines davon geaendert, wird er neu gerechnet.\nBereits gebuchte Jahre stehen dem im Weg und muessten zuerst storniert\nwerden.", "operationId": "put_fixed_asset_put", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FixedAsset" } } } }, "responses": { "200": { "description": "Das geaenderte Anlagegut" }, "409": { "description": "Der Plan waere neu zu rechnen, ist aber schon gebucht" } } } }, "\/api\/invoice\/fixed_asset\/{identifier}\/disposal": { "post": { "tags": [ "Billing \/ Anlageg\u00fcter" ], "summary": "Tr\u00e4gt den Abgang ein und bucht ihn.", "operationId": "post_fixed_asset_disposal", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "disposal_date": { "type": "string", "example": "2028-06-30" }, "disposal_proceeds": { "description": "Verkaufserloes netto", "type": "number" }, "disposal_tax_rate": { "description": "Umsatzsteuersatz auf den Erloes in Prozent; leer bei steuerfreiem Abgang", "type": "number", "example": 19 }, "disposal_reason": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Das Anlagegut mit Abgang und der Buchungssatz" } } } }, "\/api\/invoice\/cash_register": { "get": { "tags": [ "Billing \/ Kassen" ], "summary": "Die Kassen.", "operationId": "get_cash_register_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Kurzzeichen f\u00fcr die Belegnummer, etwa \"VH\" f\u00fcr Vereinsheim. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Stillgelegte Kassen nehmen keine Buchungen mehr an, bleiben aber mit ihrem Buch bestehen - die Aufzeichnungen sind aufzubewahren. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "lockedThrough", "in": "query", "description": "Bis zu welchem Tag das Kassenbuch abgeschlossen ist. Der Kassenabschluss schiebt dieses Datum vor. Bis hierhin nimmt die Kasse keine Bewegung mehr an - auch nicht am selben Tag: die Chronologiepr\u00fcfung allein lie\u00df nach dem Monatsabschluss noch eine Bewegung mit dem letzten Tag des Monats zu, und der abgeschlossene Monat w\u00e4re hinterher ein anderer gewesen als der abgeschlossene. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "ledgerAccount", "in": "query", "description": "Das Bestandskonto dieser Kasse f\u00fcr die Bilanzierung. Je Kasse ein eigenes Konto, sonst st\u00fcnden in der Bilanz beide Best\u00e4nde auf einer Zeile und lie\u00dfen sich nicht mehr trennen. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "costCenter", "in": "query", "description": "Die steuerliche Sph\u00e4re beim gemeinn\u00fctzigen Verein. Eine Kasse geh\u00f6rt meist zu einem Bereich - die Kasse am Getr\u00e4nkestand zum wirtschaftlichen Gesch\u00e4ftsbetrieb, die Kasse der Gesch\u00e4ftsstelle zum ideellen Bereich. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Kassen", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CashRegister" } } } } } } }, "post": { "tags": [ "Billing \/ Kassen" ], "summary": "Legt eine Kasse an.", "operationId": "post_cash_register_post", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "name": { "type": "string", "example": "Kasse Vereinsheim" }, "code": { "type": "string", "example": "VH" }, "ledger_account": { "type": "integer", "example": 42 }, "cost_center": { "type": "integer", "example": 3 } }, "type": "object" } } } }, "responses": { "201": { "description": "Die angelegte Kasse" } } } }, "\/api\/invoice\/cash_register\/{identifier}": { "put": { "tags": [ "Billing \/ Kassen" ], "summary": "\u00c4ndert eine Kasse.", "description": "Stammdaten, nicht Bewegungen - die bleiben unangetastet.", "operationId": "put_cash_register_put", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Die ge\u00e4nderte Kasse" } } }, "delete": { "tags": [ "Billing \/ Kassen" ], "summary": "Legt eine Kasse still oder l\u00f6scht sie, wenn sie nie bebucht wurde.", "description": "Eine Kasse mit Bewegungen zu l\u00f6schen hiesse, ein Kassenbuch zu\nvernichten. Sie wird deshalb stillgelegt: keine neuen Buchungen, das\nBuch bleibt lesbar.", "operationId": "delete_cash_register_delete", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ob gel\u00f6scht oder stillgelegt wurde" } } } }, "\/api\/invoice\/cash_transaction": { "get": { "tags": [ "Billing \/ Kassenbuch" ], "summary": "Die Bewegungen der Kasse.", "operationId": "get_cash_transaction_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "cashRegister", "in": "query", "description": "Die Kasse, zu der diese Bewegung geh\u00f6rt. Pflichtangabe: eine Kassenbewegung ohne Kasse h\u00e4tte keinen Bestand, an dem sie sich fortschreiben k\u00f6nnte. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sequenceNumber", "in": "query", "description": "Fortlaufende Nummer im Kassenbuch der jeweiligen Kasse, l\u00fcckenlos ab 1. Die L\u00fcckenlosigkeit ist der Grund f\u00fcr die Nummer: fehlt eine, ist eine Bewegung entfernt worden. Sie wird deshalb von `CashBookService` vergeben und nicht vom Aufrufer gesetzt. | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "transactionDate", "in": "query", "description": "Tag der Bewegung. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "grossAmount", "in": "query", "description": "Der Betrag, der tats\u00e4chlich die Kasse wechselt - immer brutto und immer positiv. Die Richtung steckt in `type`, nicht im Vorzeichen. Ein Vorzeichen zus\u00e4tzlich zur Richtung w\u00e4re eine zweite Wahrheit \u00fcber dieselbe Sache; bei einer Ausgabe von -50 mit type=expense w\u00fcsste niemand, ob das nun eine Einnahme ist. | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "taxRate", "in": "query", "description": "Steuersatz in Prozent, wie er auf dem Beleg steht. | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "taxAmount", "in": "query", "description": "Der Steueranteil des Bruttobetrags, aus Satz und Betrag gerechnet. | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "balanceAfter", "in": "query", "description": "Bestand der Kasse nach dieser Bewegung. | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "documentNumber", "in": "query", "description": "Belegnummer - die Nummer des Kassenbelegs, nicht die laufende Nummer. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "expenseCategory", "in": "query", "description": "Die E\u00dcR-Kategorie - dieselbe Br\u00fccke wie am Sachkonto und am Anlagegut. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contraLedgerAccount", "in": "query", "description": "Das Gegenkonto f\u00fcr die Bilanzierung - die Kasse selbst ist die andere Seite und steht im Kontenrahmen fest. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "costCenter", "in": "query", "description": "Die steuerliche Sph\u00e4re beim gemeinn\u00fctzigen Verein. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "incomingInvoice", "in": "query", "description": "Die bar bezahlte Eingangsrechnung, falls es eine gibt. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "invoice", "in": "query", "description": "Die bar kassierte Ausgangsrechnung, falls es eine gibt. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "journalEntry", "in": "query", "description": "Der Buchungssatz, sofern die Bewegung verbucht wurde. Nur bei Bilanzierung gesetzt. Bei der E\u00dcR bleibt er leer, weil es dort keine Buchungss\u00e4tze gibt - die Bewegung z\u00e4hlt trotzdem. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reversalOf", "in": "query", "description": "Die Bewegung, die diese hier storniert. Ein echter Verweis und nicht der Buchungstext: der Text ist frei editierbar, und eine Stornopr\u00fcfung, die auf \"Storno zu Nr. 4\" sucht, lie\u00dfe sich durch Umbenennen aushebeln - und tr\u00e4fe nebenbei auch \"Storno zu Nr. 41\". | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "locked", "in": "query", "description": "Festgeschrieben - die Bewegung ist unver\u00e4nderlich (GoBD). Korrigiert wird wie im Journal \u00fcber eine Gegenbewegung, nicht durch \u00c4ndern der urspr\u00fcnglichen Zeile. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Kassenbewegungen", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CashTransaction" } } } } } } }, "post": { "tags": [ "Billing \/ Kassenbuch" ], "summary": "Tr\u00e4gt eine Bewegung ins Kassenbuch ein.", "description": "Laufende Nummer und Bestand vergibt der Dienst; was daran \u00fcbergeben\nwird, wird ignoriert.", "operationId": "post_cash_transaction_post", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "transaction_date": { "type": "string", "format": "date", "example": "2026-07-31" }, "type": { "type": "string", "enum": [ "income", "expense" ], "example": "expense" }, "gross_amount": { "type": "number", "example": 23.8 }, "tax_rate": { "type": "number", "example": 19 }, "tax_amount": { "type": "number", "example": 3.8 }, "name": { "type": "string", "example": "B\u00fcromaterial" }, "document_number": { "type": "string", "example": "K-2026-041" }, "expense_category": { "type": "integer", "example": 12 }, "cash_register": { "description": "Pflicht, sobald es mehr als eine Kasse gibt", "type": "integer", "example": 1 } }, "type": "object" } } } }, "responses": { "201": { "description": "Die eingetragene Bewegung samt neuem Bestand" }, "409": { "description": "Der Bestand w\u00fcrde negativ, oder die Bewegung l\u00e4ge vor der letzten" } } } }, "\/api\/invoice\/cash_transaction\/book": { "get": { "tags": [ "Billing \/ Kassenbuch" ], "summary": "Das Kassenbuch eines Zeitraums samt Anfangs- und Endbestand.", "operationId": "get_cash_transaction_book", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Die Bewegungen des Zeitraums mit fortlaufendem Bestand" } } } }, "\/api\/invoice\/cash_transaction\/balance": { "get": { "tags": [ "Billing \/ Kassenbuch" ], "summary": "Der aktuelle Kassenbestand - was in der Schublade liegen m\u00fcsste.", "operationId": "get_cash_transaction_balance", "responses": { "200": { "description": "Der Bestand nach der letzten Bewegung" } } } }, "\/api\/invoice\/cash_transaction\/lock": { "post": { "tags": [ "Billing \/ Kassenbuch" ], "summary": "Schreibt die Bewegungen eines Zeitraums fest (Kassenabschluss).", "operationId": "post_cash_transaction_lock", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" } }, "type": "object" } } } }, "responses": { "200": { "description": "Wie viele Bewegungen festgeschrieben wurden" } } } }, "\/api\/invoice\/cash_transaction\/{identifier}\/reversal": { "post": { "tags": [ "Billing \/ Kassenbuch" ], "summary": "Storniert eine Bewegung durch eine Gegenbewegung.", "description": "Die urspr\u00fcngliche Zeile bleibt stehen. Sie zu entfernen widerspr\u00e4che der\nUnver\u00e4nderbarkeit und risse eine L\u00fccke in die laufende Nummer.", "operationId": "post_cash_transaction_reversal", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "reason": { "type": "string", "example": "Betrag falsch erfasst" } }, "type": "object" } } } }, "responses": { "201": { "description": "Die Gegenbewegung" } } } }, "\/api\/invoice\/pending_posting": { "get": { "tags": [ "Billing \/ Verbuchen" ], "summary": "Offene Belege mit Buchungsvorschlag.", "operationId": "get_pending_posting_cget", "parameters": [ { "name": "from", "in": "query", "description": "Belegdatum ab", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "to", "in": "query", "description": "Belegdatum bis", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "Belege je Belegart, Vorgabe 50", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d+" } } ], "responses": { "200": { "description": "Offene Belege samt Vorschlag und Anzahl je Belegart" } } }, "post": { "tags": [ "Billing \/ Verbuchen" ], "summary": "Verbucht einen Beleg.", "description": "Der Buchungssatz entsteht als Entwurf; festgeschrieben wird er \u00fcber den\nBuchungssatz selbst. So bleibt zwischen \"kontiert\" und \"unver\u00e4nderlich\"\nein Schritt, in dem sich etwas richten l\u00e4sst.", "operationId": "post_pending_posting_post", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "source_type": { "type": "string", "example": "INVOICE" }, "source_id": { "type": "integer", "example": 42 } }, "type": "object" } } } }, "responses": { "200": { "description": "Der erzeugte Buchungssatz" } } } }, "\/api\/invoice\/vat_return": { "get": { "tags": [ "Billing \/ Umsatzsteuer" ], "summary": "Die Voranmeldung eines Zeitraums.", "operationId": "get_vat_return_get", "parameters": [ { "name": "year", "in": "query", "description": "Jahr, Vorgabe das laufende", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}" } }, { "name": "period", "in": "query", "description": "Monat 1-12 oder Quartal 1-4", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{1,2}" } }, { "name": "filing_period", "in": "query", "description": "MONTHLY oder QUARTERLY, \u00fcberschreibt die Einstellung", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Die Voranmeldung mit den amtlichen Kennzahlen" } } } }, "\/api\/invoice\/vat_return\/overview": { "get": { "tags": [ "Billing \/ Umsatzsteuer" ], "summary": "Alle Zeitr\u00e4ume eines Jahres mit ihrer Zahllast.", "operationId": "get_vat_return_overview", "parameters": [ { "name": "year", "in": "query", "description": "Jahr, Vorgabe das laufende", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}" } }, { "name": "filing_period", "in": "query", "description": "MONTHLY oder QUARTERLY", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Jahres\u00fcberblick der Voranmeldungen" } } } }, "\/api\/invoice\/vat_return\/filing_period": { "get": { "tags": [ "Billing \/ Umsatzsteuer" ], "summary": "Welcher Voranmeldungszeitraum nach \u00a7 18 Abs. 2 UStG gilt.", "description": "Ein Vorschlag mit Begr\u00fcndung: die Befreiung unterhalb der unteren\nGrenze ist eine Kann-Vorschrift des Finanzamts, keine Automatik.", "operationId": "get_vat_return_filing_period", "parameters": [ { "name": "year", "in": "query", "description": "Jahr, Vorgabe das laufende", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}" } } ], "responses": { "200": { "description": "Vorschlag f\u00fcr den Voranmeldungszeitraum" } } } }, "\/api\/invoice\/vat_return\/submit": { "post": { "tags": [ "Billing \/ Umsatzsteuer" ], "summary": "Schreibt eine Voranmeldung als abgegeben fest.", "description": "Ab hier stehen ihre Zahlen fest. Wird ein Beleg spaeter storniert oder\narchiviert, aendert das die abgegebene Anmeldung nicht mehr rueckwirkend -\ndie Abweichung wird stattdessen ausgewiesen, und die Berichtigung ist\neine neue Fassung desselben Zeitraums.", "operationId": "post_vat_return_submit", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "year": { "type": "integer", "example": 2026 }, "period": { "type": "integer", "example": 1 }, "filing_period": { "type": "string", "example": "QUARTERLY" }, "correction_reason": { "description": "Pflicht ab der zweiten Fassung", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Die festgeschriebene Voranmeldung" } } } }, "\/api\/invoice\/vat_return\/categories": { "get": { "tags": [ "Billing \/ Umsatzsteuer" ], "summary": "Die umsatzsteuerlichen Sachverhalte und die Kennzahlen des Vordrucks.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngehoert: null Prozent stehen an einer innergemeinschaftlichen Lieferung,\nan einer Ausfuhr, an einer Leistung nach \u00a7 13b UStG und an einem\nsteuerfreien Umsatz - vier verschiedene Zeilen. Der Sachverhalt haengt\ndeshalb am Beleg, und diese Liste sagt, welche es gibt.", "operationId": "get_vat_categories", "responses": { "200": { "description": "Sachverhalte und Kennzahlen" } } } }, "\/api\/invoice\/vat_return\/filings": { "get": { "tags": [ "Billing \/ Umsatzsteuer" ], "summary": "Alle Fassungen eines Zeitraums - der Verlauf einer Berichtigung.", "operationId": "get_vat_return_filings", "parameters": [ { "name": "year", "in": "query", "description": "", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}" } }, { "name": "period", "in": "query", "description": "", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{1,2}" } }, { "name": "filing_period", "in": "query", "description": "MONTHLY oder QUARTERLY", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Die abgegebenen Fassungen, aelteste zuerst" } } } }, "\/api\/invoice\/vat_return\/filings\/{id}\/payment": { "post": { "tags": [ "Billing \/ Umsatzsteuer" ], "summary": "H\u00e4lt Zahlung oder Erstattung einer abgegebenen Voranmeldung fest.", "description": "F\u00fcr die E\u00dcR nach der Bruttomethode (billing_euer_gross_method): die\ngezahlte Umsatzsteuer ist Betriebsausgabe, die Erstattung\nBetriebseinnahme, jeweils am Tag der Zahlung. Ohne payment_date wird die\nZahlung wieder entfernt.", "operationId": "post_vat_return_payment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "payment_date": { "type": "string", "format": "date", "example": "2026-01-08" }, "amount": { "description": "Positiv gezahlt, negativ erstattet; ohne Angabe die Kennzahl 83", "type": "number" } }, "type": "object" } } } }, "responses": { "200": { "description": "Die Voranmeldung mit Zahlung" } } } }, "\/api\/invoice\/opening_balance\/{identifier}": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Der Vorschlag f\u00fcr die Er\u00f6ffnungsbilanz eines Gesch\u00e4ftsjahres.", "operationId": "get_opening_balance_get", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Vorschlag mit abgeleiteten Positionen und \u00dcbergangsgewinn" } } }, "post": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Bucht die Er\u00f6ffnungsbilanz aus den gepr\u00fcften Positionen.", "description": "Das Eigenkapital wird nicht mitgegeben - es ergibt sich als Differenz\nund wird serverseitig errechnet. Eine Er\u00f6ffnungsbilanz geht so immer\nauf, und ein negatives Kapital ist eine Aussage, kein Fehler.", "operationId": "post_opening_balance_post", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "positions": { "type": "array", "items": { "properties": { "account_number": { "type": "string", "example": "1200" }, "side": { "type": "string", "example": "debit" }, "amount": { "type": "number", "example": 1234.56 }, "label": { "type": "string", "example": "Bankguthaben" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Die erzeugte Er\u00f6ffnungsbuchung", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/JournalEntry" } } } } } } }, "\/api\/invoice\/chart_of_accounts": { "get": { "tags": [ "Billing \/ Kontenrahmen" ], "summary": "Verf\u00fcgbare Kontenrahmen.", "operationId": "get_chart_of_accounts_cget", "responses": { "200": { "description": "Liste der unterst\u00fctzten Kontenrahmen" } } } }, "\/api\/invoice\/chart_of_accounts\/{identifier}\/preview": { "get": { "tags": [ "Billing \/ Kontenrahmen" ], "summary": "Vorschau: was ein Lauf anlegen w\u00fcrde.", "operationId": "get_chart_of_accounts_preview", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Vorschau der Initialisierung" } } } }, "\/api\/invoice\/chart_of_accounts\/initialize": { "post": { "tags": [ "Billing \/ Kontenrahmen" ], "summary": "Kontenrahmen anlegen.", "description": "Wiederholbar: vorhandene Konten bleiben unangetastet, auch abweichend\ngepflegte. Es kommen nur fehlende hinzu.", "operationId": "post_chart_of_accounts_initialize", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "chart": { "type": "string", "example": "SKR04" }, "with_sphere_cost_centers": { "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Ergebnis der Initialisierung" } } } }, "\/api\/invoice\/chart_of_accounts\/sphere_cost_centers": { "post": { "tags": [ "Billing \/ Kontenrahmen" ], "summary": "Nur die Kostenstellen der vier steuerlichen Sph\u00e4ren anlegen.", "description": "Auch ein Verein, der nach SKR03 oder SKR04 bucht, braucht die\nSph\u00e4rentrennung.", "operationId": "post_chart_of_accounts_sphere_cost_centers", "responses": { "200": { "description": "Anzahl der angelegten Kostenstellen" } } } }, "\/api\/invoice\/accounting\/{identifier}\/balance_sheet": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Bilanz eines Gesch\u00e4ftsjahres.", "operationId": "get_accounting_balance_sheet", "parameters": [ { "name": "cost_center", "in": "query", "description": "Auf eine Sph\u00e4re eingrenzen", "schema": { "type": "string" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bilanz zum Stichtag" } } } }, "\/api\/invoice\/accounting\/{identifier}\/profit_and_loss": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Gewinn- und Verlustrechnung eines Gesch\u00e4ftsjahres.", "operationId": "get_accounting_profit_and_loss", "parameters": [ { "name": "cost_center", "in": "query", "schema": { "type": "string" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Gewinn- und Verlustrechnung" } } } }, "\/api\/invoice\/accounting\/{identifier}\/trial_balance": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Summen- und Saldenliste eines Gesch\u00e4ftsjahres.", "operationId": "get_accounting_trial_balance", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Summen- und Saldenliste" } } } }, "\/api\/invoice\/accounting\/{identifier}\/spheres": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Ergebnis je steuerlicher Sph\u00e4re.", "description": "F\u00fcr den gemeinn\u00fctzigen Verein die entscheidende Auswertung: nur der\nwirtschaftliche Gesch\u00e4ftsbetrieb ist steuerpflichtig.", "operationId": "get_accounting_spheres", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ergebnis je Sph\u00e4re" } } } }, "\/api\/invoice\/accounting\/{identifier}\/hgb_balance_sheet": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Bilanz in der Gliederung des \u00a7 266 HGB, mit Vorjahreswerten.", "description": "Die gewoehnliche Bilanz ist eine Kontenliste - richtig gerechnet, aber\nnicht in der Form, die das Gesetz vorgibt. Hier stehen die Posten des\n\u00a7 266 HGB, je mit dem Vorjahresbetrag (\u00a7 265 Abs. 2 HGB) und den\nKonten, aus denen sie entstanden sind.", "operationId": "get_accounting_hgb_balance_sheet", "parameters": [ { "name": "cost_center", "in": "query", "description": "Auf eine Sphaere eingrenzen", "schema": { "type": "string" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bilanz nach \u00a7 266 HGB" } } } }, "\/api\/invoice\/accounting\/{identifier}\/hgb_profit_and_loss": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Gewinn- und Verlustrechnung in der Staffelform des \u00a7 275 Abs. 2 HGB.", "operationId": "get_accounting_hgb_profit_and_loss", "parameters": [ { "name": "cost_center", "in": "query", "schema": { "type": "string" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "GuV nach \u00a7 275 Abs. 2 HGB" } } } }, "\/api\/invoice\/accounting\/open_items": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Offene Posten - Debitoren und Kreditoren mit Faelligkeitsstaffel.", "description": "Was noch nicht bezahlt ist, und seit wann. Die Staffel sagt, welche\nHandlung ein Posten verlangt: zehn Tage ueberfaellig wird gemahnt,\nneunzig Tage ueberfaellig wird wertberichtigt.", "operationId": "get_accounting_open_items", "parameters": [ { "name": "as_of", "in": "query", "description": "Stichtag, Vorgabe heute", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Offene Posten beider Seiten" } } } }, "\/api\/invoice\/accounting\/{identifier}\/gobd_export": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Datentraegerueberlassung nach \u00a7 147 Abs. 6 AO.", "description": "Der Export, nach dem eine Betriebspruefung fragt: die steuerrelevanten\nDaten in maschinell auswertbarer Form, samt der index.xml des\nGoBD-Beschreibungsstandards. Ohne sie waere ein CSV-Ordner kein Export,\nsondern ein Haufen Dateien.\n\nAusgegeben werden nur festgeschriebene Buchungen - Entwuerfe sind keine\nBuchfuehrung.", "operationId": "get_accounting_gobd_export", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ZIP mit index.xml und den Datendateien" } } } }, "\/api\/invoice\/accounting\/tax_thresholds": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Zeitabhaengige steuerliche Wertgrenzen eines Jahres.", "description": "Freigrenze des wirtschaftlichen Geschaeftsbetriebs, Zweckbetriebsgrenze,\nUebungsleiterfreibetrag und Ehrenamtspauschale - je mit Fundstelle,\nAnwendungsjahr und Verlauf.", "operationId": "get_accounting_tax_thresholds", "parameters": [ { "name": "year", "in": "query", "description": "Jahr, Vorgabe das laufende", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}" } } ], "responses": { "200": { "description": "Die Wertgrenzen des Jahres" } } } }, "\/api\/invoice\/accounting\/year_end_adjustments": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Katalog der bilanziellen Abschlussarbeiten.", "description": "Welche Umbuchungen zum Jahresabschluss gehoeren, auf welche Konten sie\nlaufen und woher sie kommen. Der Dienst rechnet nichts aus - wie hoch\neine Rueckstellung ist, entscheidet ein Mensch -, aber er kennt die\nKonten und die richtige Seite.", "operationId": "get_accounting_year_end_adjustments", "responses": { "200": { "description": "Die Abschlussbuchungen des eingestellten Kontenrahmens" } } } }, "\/api\/invoice\/accounting\/{identifier}\/year_end_checklist": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Checkliste der Abschlussarbeiten eines Geschaeftsjahres.", "description": "Keine Blocker: eine Rueckstellung laesst sich nicht erzwingen, und ein\nBetrieb ohne Warenlager braucht keine Inventur. Die Liste sagt, woran zu\ndenken ist, und ob im Jahr schon etwas davon gebucht wurde.", "operationId": "get_accounting_year_end_checklist", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Checkliste mit dem Stand des Jahres" } } } }, "\/api\/invoice\/accounting\/{identifier}\/year_end_adjustment": { "post": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Bucht eine Abschlussbuchung.", "operationId": "post_post_accounting_year_end_adjustment", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "required": [ "type", "amount", "description" ], "properties": { "type": { "type": "string", "default": null }, "amount": { "type": "string", "default": null }, "description": { "type": "string", "default": null }, "counter_account": { "type": "string", "default": null }, "entry_date": { "type": "string", "default": null }, "tax_rate": { "type": "string", "default": null }, "cost_center": { "type": "string", "default": null }, "document_number": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "201": { "description": "Der gebuchte Satz" } } } }, "\/api\/invoice\/accounting\/{identifier}\/report.csv": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Eine Auswertung als CSV.", "description": "Die Auswertungen selbst bleiben JSON - die Oberflaeche liest sie. Wer\ndamit weiterrechnen will, holt sie hier: deutsches Format mit Semikolon\nund Komma, damit Excel die Zahlen als Zahlen liest und nicht als Text.", "operationId": "get_accounting_report_csv", "parameters": [ { "name": "report", "in": "query", "description": "Welche Auswertung", "schema": { "type": "string" } }, { "name": "cost_center", "in": "query", "schema": { "type": "string" } }, { "name": "as_of", "in": "query", "description": "Stichtag der offenen Posten", "schema": { "type": "string" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Die Auswertung als CSV" } } } }, "\/api\/invoice\/accounting\/{identifier}\/datev_export\/preview": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Was der Buchungsstapel enthalten wuerde - ohne ihn zu erzeugen.", "description": "Die Kanzlei bekommt den Stapel einmal; wenn darin etwas fehlt, faellt es\ndort auf und nicht hier. Deshalb zuerst die Vorschau: wie viele Saetze es\nwerden, und welche Buchungen sich nicht als Buchungssatz abbilden lassen,\nsamt Grund. Was hier steht, muss die Kanzlei von Hand erfassen - besser\nsie weiss es vorher.", "operationId": "get_accounting_datev_export_preview", "parameters": [ { "name": "from", "in": "query", "description": "Beginn des Zeitraums, Vorgabe der Jahresbeginn", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "to", "in": "query", "description": "Ende des Zeitraums, Vorgabe das Jahresende", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Anzahl der Saetze und die uebersprungenen Buchungen" } } } }, "\/api\/invoice\/accounting\/{identifier}\/datev_export": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Der Buchungsstapel im DATEV-Format.", "description": "Die Datei, die eine Kanzlei in DATEV Kanzlei-Rechnungswesen einliest.\nAusgegeben werden ausschliesslich festgeschriebene Buchungen - ein\nEntwurf ist keine Buchfuehrung, und ein Stapel mit Entwuerfen darin\nwuerde in der Kanzlei zu Buchungen, die es bei uns nie gab.", "operationId": "get_accounting_datev_export", "parameters": [ { "name": "from", "in": "query", "description": "Beginn des Zeitraums, Vorgabe der Jahresbeginn", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "to", "in": "query", "description": "Ende des Zeitraums, Vorgabe das Jahresende", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Der Buchungsstapel als CSV im DATEV-Format" } } } }, "\/api\/invoice\/accounting\/ledger\/{identifier}": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Kontenblatt: alle Buchungszeilen eines Kontos mit laufendem Saldo.", "description": "Ohne chart_of_accounts wird der Bezeichner als Id gelesen. Das ist hier\ndie einzige eindeutige Angabe: Kontonummern sind selbst Zahlen, und\n\"1200\" w\u00e4re sonst nicht zu unterscheiden von der Id 1200 - bei \u00fcber\ntausend Konten je Rahmen fast immer ein anderes Konto, ohne dass es\nauffiele. Wer in Kontonummern denkt, gibt den Rahmen dazu an; innerhalb\neines Rahmens ist die Nummer eindeutig.", "operationId": "get_accounting_ledger", "parameters": [ { "name": "fiscal_year", "in": "query", "description": "Gesch\u00e4ftsjahr", "schema": { "type": "string" } }, { "name": "chart_of_accounts", "in": "query", "description": "Den Bezeichner als Kontonummer dieses Rahmens lesen", "schema": { "type": "string" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Kontenblatt" } } } }, "\/api\/invoice\/ledger_account": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Sachkonten.", "description": "Mit \"search\" wird \u00fcber Nummer und Bezeichnung gesucht statt gefiltert.\nEin voller Kontenrahmen hat \u00fcber tausend Konten; eine Auswahlliste zum\nDurchbl\u00e4ttern w\u00e4re unbrauchbar, und die \u00fcbrigen Filter treffen nur\nexakt. Die Trefferzahl ist begrenzt - wer sucht, will die ersten\npassenden sehen, nicht alle.", "operationId": "get_ledger_account_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "number", "in": "query", "description": "Kontonummer im Kontenrahmen, z.B. \"1200\" (SKR03 Bank) oder \"40000\" (SKR42). Als String gef\u00fchrt, weil SKR42 f\u00fcnfstellig ist und f\u00fchrende Nullen bedeutungstragend sein k\u00f6nnen. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "chartOfAccounts", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "accountType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "defaultTax", "in": "query", "description": "Steuersatz, der beim Buchen auf dieses Konto vorgeschlagen wird. Bei Erl\u00f6s- und Aufwandskonten ist der Satz durch die Kontonummer vorgegeben (etwa \"Erl\u00f6se 19% USt\"), deshalb h\u00e4ngt er am Konto und nicht an der einzelnen Buchung. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "taxAccount", "in": "query", "description": "Gegenkonto f\u00fcr die Steuer, die beim Buchen auf dieses Konto entsteht. Bei Erl\u00f6skonten das Umsatzsteuerkonto, bei Aufwandskonten das Vorsteuerkonto. Damit l\u00e4sst sich aus einem Bruttobetrag automatisch der dreizeilige Buchungssatz erzeugen. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "expenseCategory", "in": "query", "description": "Br\u00fccke zur E\u00dcR: auf welcher Zeile der Anlage E\u00dcR dieses Konto z\u00e4hlt. Erlaubt es, beide Gewinnermittlungsarten aus denselben Belegen zu bedienen - etwa im Wechseljahr oder wenn ein Verein den wirtschaftlichen Gesch\u00e4ftsbetrieb per E\u00dcR und den Rest bilanziell f\u00fchrt. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "costCenterRequired", "in": "query", "description": "Ob auf diesem Konto eine Kostenstelle angegeben werden muss. Der SKR42 bildet die vier steuerlichen Sph\u00e4ren eines gemeinn\u00fctzigen Vereins \u00fcber Kostenstellen ab, nicht \u00fcber getrennte Konten. F\u00fcr die Erfolgskonten ist die Angabe dort deshalb Pflicht. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "isSystem", "in": "query", "description": "Vom Kontenrahmen-Initialisierer angelegt. Nummer und Art sind dann durch den Rahmen vorgegeben und sollten nicht ge\u00e4ndert werden. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "isActive", "in": "query", "description": "Konten lassen sich stilllegen, statt sie zu l\u00f6schen - bebuchte Konten d\u00fcrfen nicht verschwinden. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Sachkonten", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/LedgerAccount" } } } } } } }, "post": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Creates a new ledger account entry.", "operationId": "post_ledger_account_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/LedgerAccount" } }, "type": "object" } } } }, "responses": { "200": { "description": "Sachkonto anlegen", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LedgerAccount" } } } } } } }, "\/api\/invoice\/ledger_account\/{identifier}": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Returns a single ledger account entry.", "operationId": "get_ledger_account_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sachkonto", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LedgerAccount" } } } } } }, "put": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Updates an existing ledger account entry.", "operationId": "put_ledger_account_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/LedgerAccount" } }, "type": "object" } } } }, "responses": { "200": { "description": "Sachkonto \u00e4ndern", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LedgerAccount" } } } } } }, "patch": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Updates an existing ledger account entry.", "operationId": "patch_ledger_account_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/LedgerAccount" } }, "type": "object" } } } }, "responses": { "200": { "description": "Sachkonto \u00e4ndern", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LedgerAccount" } } } } } } }, "\/api\/invoice\/cost_center": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Returns a list of cost center entries.", "operationId": "get_cost_center_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "number", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sphere", "in": "query", "description": "Steuerliche Sph\u00e4re, null bei rein betriebswirtschaftlicher Gliederung. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isSystem", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "isActive", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Kostenstellen", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CostCenter" } } } } } } }, "post": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Creates a new cost center entry.", "operationId": "post_cost_center_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CostCenter" } }, "type": "object" } } } }, "responses": { "200": { "description": "Kostenstelle anlegen", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CostCenter" } } } } } } }, "\/api\/invoice\/cost_center\/{identifier}": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Returns a single cost center entry.", "operationId": "get_cost_center_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Kostenstelle", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CostCenter" } } } } } }, "put": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Updates an existing cost center entry.", "operationId": "put_cost_center_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CostCenter" } }, "type": "object" } } } }, "responses": { "200": { "description": "Kostenstelle \u00e4ndern", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CostCenter" } } } } } }, "patch": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Updates an existing cost center entry.", "operationId": "patch_cost_center_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CostCenter" } }, "type": "object" } } } }, "responses": { "200": { "description": "Kostenstelle \u00e4ndern", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CostCenter" } } } } } } }, "\/api\/invoice\/fiscal_year": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Returns a list of fiscal year entries.", "operationId": "get_fiscal_year_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "openingBalanceEntered", "in": "query", "description": "Ob die Er\u00f6ffnungsbilanzwerte erfasst sind. Beim ersten Gesch\u00e4ftsjahr einer Installation - oder beim Wechsel von der E\u00dcR zur Bilanzierung - m\u00fcssen die Anfangsbest\u00e4nde einmalig eingebucht werden, sonst stimmt die Bilanz nicht. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "closingEntry", "in": "query", "description": "Die Abschlussbuchung dieses Jahres. Ohne diesen Verweis war der vorl\u00e4ufige Abschluss eine Sackgasse: das Wieder\u00f6ffnen setzte den Status zur\u00fcck, die Buchung blieb stehen, und der endg\u00fcltige Abschluss fand keine Salden mehr vor. Mit dem Verweis l\u00e4sst sich die Buchung beim Wieder\u00f6ffnen stornieren und der Abschluss beliebig oft wiederholen. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "closedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "closedBy", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Geschaeftsjahre", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FiscalYear" } } } } } } }, "post": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Creates a new fiscal year entry.", "operationId": "post_fiscal_year_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/FiscalYear" } }, "type": "object" } } } }, "responses": { "200": { "description": "Geschaeftsjahr anlegen", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FiscalYear" } } } } } } }, "\/api\/invoice\/fiscal_year\/{identifier}": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Returns a single fiscal year entry.", "operationId": "get_fiscal_year_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Geschaeftsjahr", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FiscalYear" } } } } } }, "put": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Updates an existing fiscal year entry.", "operationId": "put_fiscal_year_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/FiscalYear" } }, "type": "object" } } } }, "responses": { "200": { "description": "Geschaeftsjahr \u00e4ndern", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FiscalYear" } } } } } }, "patch": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Updates an existing fiscal year entry.", "operationId": "patch_fiscal_year_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/FiscalYear" } }, "type": "object" } } } }, "responses": { "200": { "description": "Geschaeftsjahr \u00e4ndern", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FiscalYear" } } } } } } }, "\/api\/invoice\/fiscal_year\/{identifier}\/closing_blockers": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Was einem Abschluss noch im Weg steht.", "description": "Wird vor dem Abschluss angezeigt, damit niemand gegen eine Ausnahme\nlaeuft.", "operationId": "get_fiscal_year_closing_blockers", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Offene Punkte vor dem Abschluss" } } } }, "\/api\/invoice\/fiscal_year\/{identifier}\/close": { "post": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Geschaeftsjahr abschliessen.", "description": "Schliesst die Erfolgskonten ueber das Ergebnis auf das Eigenkapital ab.\nVorlaeufig laesst sich das Jahr noch einmal oeffnen, endgueltig nicht.", "operationId": "post_fiscal_year_close", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "chart": { "type": "string", "example": "SKR04" }, "provisional": { "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Die erzeugte Abschlussbuchung" } } } }, "\/api\/invoice\/fiscal_year\/{identifier}\/reopen": { "post": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Ein vorlaeufig abgeschlossenes Jahr wieder oeffnen.", "operationId": "post_fiscal_year_reopen", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Das wieder geoeffnete Geschaeftsjahr" } } } }, "\/api\/invoice\/fiscal_year\/{identifier}\/carry_forward": { "post": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Saldenvortrag ins Folgejahr.", "description": "Uebertraegt die Bestaende der Bilanzkonten - ohne diesen Schritt begaenne\ndas neue Jahr mit leeren Konten.", "operationId": "post_fiscal_year_carry_forward", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "target_fiscal_year": { "type": "string", "example": "2027" }, "chart": { "type": "string", "example": "SKR04" } }, "type": "object" } } } }, "responses": { "200": { "description": "Die erzeugte Eroeffnungsbuchung" } } } }, "\/api\/invoice\/journal_entry": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Journal - alle Buchungss\u00e4tze.", "operationId": "get_journal_entry_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "entryNumber", "in": "query", "description": "Fortlaufende Buchungsnummer, vergeben beim Festschreiben. Erst dann, weil die GoBD eine l\u00fcckenlose Nummerierung der festgeschriebenen Buchungen verlangt - eine verworfene Erfassung darf keine L\u00fccke hinterlassen. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "entryDate", "in": "query", "description": "Buchungsdatum - bestimmt, in welche Periode die Buchung f\u00e4llt. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "Belegdatum - das Datum auf dem Papier. Kann vom Buchungsdatum abweichen. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "documentNumber", "in": "query", "description": "Belegnummer - die Br\u00fccke zwischen Buchung und Beleg. Ohne sie ist die Buchung nicht nachvollziehbar (\"keine Buchung ohne Beleg\"). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "fiscalYear", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Buchungsperiode innerhalb des Gesch\u00e4ftsjahres. 1 bis 12 f\u00fcr die laufenden Monate, 13 f\u00fcr die Abschlussperiode. Die Zahl wird aus dem Buchungsdatum abgeleitet, sobald sie nicht ausdr\u00fccklich gesetzt ist - nur der Abschluss setzt sie selbst. Die Spalte heisst `accounting_period` und nicht `period`: MariaDB h\u00e4lt PERIOD seit der System-Versionierung (`PERIOD FOR SYSTEM_TIME`) als Schl\u00fcsselwort frei, und die Migration scheitert daran. Das Feld in PHP bleibt `period` - DQL und die JSON-Ausgabe \u00e4ndern sich damit nicht. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sourceType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sourceId", "in": "query", "description": "Id des ausl\u00f6senden Belegs, damit sich Buchung und Beleg gegenseitig finden - und damit derselbe Beleg nicht zweimal gebucht wird. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reversalOf", "in": "query", "description": "Die Buchung, die durch diese hier storniert wird. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "postedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "postedBy", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Buchungss\u00e4tze", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/JournalEntry" } } } } } } }, "post": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Buchungssatz erfassen.", "description": "Der Satz entsteht als Entwurf. Erst das Festschreiben macht ihn\nunver\u00e4nderlich.", "operationId": "post_journal_entry_post", "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "type": "object" }, "lines": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Buchungssatz anlegen", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/JournalEntry" } } } } } } }, "\/api\/invoice\/journal_entry\/{identifier}\/validate": { "get": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Pr\u00fcfen, ohne zu speichern.", "operationId": "get_journal_entry_validate", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Gefundene M\u00e4ngel, leer wenn buchbar" } } } }, "\/api\/invoice\/journal_entry\/{identifier}\/reverse": { "post": { "tags": [ "Billing \/ Bilanzierung" ], "summary": "Buchungssatz stornieren.", "description": "Erzeugt eine Gegenbuchung; die urspr\u00fcngliche bleibt unangetastet.", "operationId": "post_journal_entry_reverse", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "reversal_date": { "type": "string", "format": "date" } }, "type": "object" } } } }, "responses": { "200": { "description": "Die erzeugte Stornobuchung", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/JournalEntry" } } } } } } }, "\/api\/invoice\/euer_report\/preview\/{year}": { "get": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Preview E\u00dcR report for a year (without saving)", "operationId": "get_euer_report_preview", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "year", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/euer_report\/monthly\/{year}": { "get": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Get monthly breakdown for a year", "operationId": "get_euer_report_monthly", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "year", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/euer_report\/summary\/{year}": { "get": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Get yearly summary", "operationId": "get_euer_report_summary", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "year", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/euer_report\/compare\/{id1}\/{id2}": { "get": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Compare two reports", "operationId": "get_euer_report_compare", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id1", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "id2", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/invoice\/euer_report\/generate": { "post": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Generate and save a new E\u00dcR Report for a fiscal year", "operationId": "post_euer_report_generate", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "fiscalYear": { "type": "integer", "example": 2024 }, "accountingMethod": { "type": "string", "enum": [ "cash_basis", "accrual" ], "example": "cash_basis" }, "notes": { "type": "string", "example": "Annual report" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Generate a new E\u00dcR Report", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EuerReport" } } } } } } }, "\/api\/invoice\/euer_report\/{identifier}": { "get": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Get a single E\u00dcR Report", "operationId": "get_euer_report_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Get a single E\u00dcR Report", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EuerReport" } } } } } }, "put": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Update an E\u00dcR Report (only draft reports, only notes\/internalDescription)", "operationId": "put_euer_report_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EuerReport2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an E\u00dcR Report", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EuerReport" } } } } } }, "delete": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Delete an E\u00dcR Report (soft delete, only draft reports)", "operationId": "delete_euer_report_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Delete an E\u00dcR Report", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EuerReport" } } } } } }, "patch": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Update an E\u00dcR Report (only draft reports, only notes\/internalDescription)", "operationId": "patch_euer_report_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EuerReport2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an E\u00dcR Report", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EuerReport" } } } } } } }, "\/api\/invoice\/euer_report\/{identifier}\/pdf": { "get": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Die E\u00dcR als PDF.", "description": "Die Fassung, die zum Steuerberater geht und ins Archiv. Sie nennt\ndeshalb nicht nur die Zahlen, sondern auch, wie sie zustande gekommen\nsind - nach Zufluss oder nach Rechnungsdatum -, und ob der Bericht schon\nfestgeschrieben ist. Ein Entwurf sagt das im Dokument selbst; sonst\nl\u00e4ge irgendwann ein Ausdruck in einer Akte, dem man nicht ansieht, dass\ner vorl\u00e4ufig war.", "operationId": "get_euer_report_pdf", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Die E\u00dcR als PDF" }, "404": { "description": "Der Bericht wurde nicht gefunden" } } } }, "\/api\/invoice\/euer_report\/{identifier}\/finalize": { "post": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Finalize an E\u00dcR Report (lock from further changes)", "operationId": "post_euer_report_finalize", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Finalize an E\u00dcR Report", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EuerReport" } } } } } } }, "\/api\/invoice\/euer_report\/{identifier}\/regenerate": { "post": { "tags": [ "Billing \/ E\u00dcR Report" ], "summary": "Regenerate report data (only for draft reports)", "operationId": "post_euer_report_regenerate", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Regenerate E\u00dcR Report data", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EuerReport" } } } } } } }, "\/api\/invoice\/auto_dunning\/preview": { "get": { "tags": [ "Billing \/ AutoDunning" ], "summary": "Preview of the dunning run: which accounts would move to which level with which fee and interest.", "description": "Changes nothing and also works while the run is disabled.", "operationId": "get_invoice_auto_dunning_preview", "parameters": [ { "name": "date", "in": "query", "description": "Run as of this date (YYYY-MM-DD), default today", "required": false, "schema": { "type": "string" } }, { "name": "companies", "in": "query", "description": "Comma separated account ids to limit the run to", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns enabled, dryRun, date, settings, actions and skipped accounts" } } } }, "\/api\/invoice\/auto_dunning\/run": { "post": { "tags": [ "Billing \/ AutoDunning" ], "summary": "Executes the dunning run now (the same run the daily cron task does).", "operationId": "post_invoice_auto_dunning_run", "parameters": [ { "name": "companies", "in": "query", "description": "Comma separated account ids to limit the run to", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns enabled, dryRun, date, settings, actions and skipped accounts" } } } }, "\/api\/invoice\/bill_reminder": { "get": { "tags": [ "Billing \/ BillReminder" ], "summary": "This method will get all BillReminder Objects", "operationId": "get_bill_reminder_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "globalDefault", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "billReminderCount", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "template", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "predefinedBillingItem", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BillReminder objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BillReminder" } } } } } } }, "post": { "tags": [ "Billing \/ BillReminder" ], "summary": "Add a new BillReminder", "operationId": "post_bill_reminder_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillReminder2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BillReminder", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillReminder" } } } } } } }, "\/api\/invoice\/bill_reminder\/{identifier}": { "get": { "tags": [ "Billing \/ BillReminder" ], "summary": "Get a single BillReminder", "operationId": "get_bill_reminder_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single BillReminder", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillReminder" } } } } } }, "put": { "tags": [ "Billing \/ BillReminder" ], "summary": "Update a BillReminder", "operationId": "put_bill_reminder_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillReminder2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BillReminder", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillReminder" } } } } } }, "patch": { "tags": [ "Billing \/ BillReminder" ], "summary": "Update a BillReminder", "operationId": "patch_bill_reminder_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BillReminder2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BillReminder", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BillReminder" } } } } } } }, "\/api\/invoice\/tax": { "get": { "tags": [ "Billing \/ Tax" ], "summary": "Returns a list of all Tax", "operationId": "get_tax_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all Tax", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Tax" } } } } } } }, "post": { "tags": [ "Billing \/ Tax" ], "summary": "Add a new Tax", "operationId": "post_tax_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/Tax" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new Tax", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Tax" } } } } } } }, "\/api\/invoice\/tax\/{identifier}": { "get": { "tags": [ "Billing \/ Tax" ], "summary": "Get a single Tax", "operationId": "get_tax_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single Tax", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Tax" } } } } } }, "put": { "tags": [ "Billing \/ Tax" ], "summary": "Update a Tax", "operationId": "put_tax_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/Tax" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a Tax", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Tax" } } } } } }, "patch": { "tags": [ "Billing \/ Tax" ], "summary": "Update a Tax", "operationId": "patch_tax_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/Tax" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a Tax", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Tax" } } } } } } }, "\/api\/invoice\/payment_goal": { "get": { "tags": [ "Billing \/ PaymentGoal" ], "summary": "Returns a list of all PaymentGoal", "operationId": "get_payment_goal_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "dateString", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "globalDefault", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of PaymentGoal objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PaymentGoal" } } } } } } }, "post": { "tags": [ "Billing \/ PaymentGoal" ], "summary": "Add a new PaymentGoal", "operationId": "post_payment_goal_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PaymentGoal" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new PaymentGoal", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentGoal" } } } } } } }, "\/api\/invoice\/payment_goal\/{identifier}": { "get": { "tags": [ "Billing \/ PaymentGoal" ], "summary": "Get a single PaymentGoal", "operationId": "get_payment_goal_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single PaymentGoal", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentGoal" } } } } } }, "put": { "tags": [ "Billing \/ PaymentGoal" ], "summary": "Update a PaymentGoal", "operationId": "put_payment_goal_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PaymentGoal" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a PaymentGoal", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentGoal" } } } } } }, "patch": { "tags": [ "Billing \/ PaymentGoal" ], "summary": "Update a PaymentGoal", "operationId": "patch_payment_goal_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PaymentGoal" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a PaymentGoal", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentGoal" } } } } } } }, "\/api\/invoice\/payment_type": { "get": { "tags": [ "Billing \/ PaymentType" ], "summary": "Returns a list of all PaymentType", "operationId": "get_payment_type_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all PaymentType", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PaymentType" } } } } } } }, "post": { "tags": [ "Billing \/ PaymentType" ], "summary": "Add a new PaymentType", "operationId": "post_payment_type_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PaymentType" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new PaymentType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentType" } } } } } } }, "\/api\/invoice\/payment_type\/{identifier}": { "get": { "tags": [ "Billing \/ PaymentType" ], "summary": "Get a single PaymentType", "operationId": "get_payment_type_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single PaymentType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentType" } } } } } }, "put": { "tags": [ "Billing \/ PaymentType" ], "summary": "Update a PaymentType", "operationId": "put_payment_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PaymentType" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a PaymentType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentType" } } } } } }, "patch": { "tags": [ "Billing \/ PaymentType" ], "summary": "Update a PaymentType", "operationId": "patch_payment_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/PaymentType" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a PaymentType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PaymentType" } } } } } } }, "\/api\/invoice\/shipping_price\/calculate\/{countryCode}\/{zipCode}\/{shippingType}": { "get": { "tags": [ "Billing \/ Shipping" ], "summary": "Returns a dummy offer with calculated shipping price", "operationId": "get_shipping_price_public_calculate", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "countryCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "zipCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "shippingType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a dummy offer with calculated shipping price", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Offer5" } } } } } } }, "\/api\/time\/employment\/contracts": { "get": { "tags": [ "TimeTracking \/ EmploymentContract" ], "summary": "This method will get all EmploymentContract Objects", "operationId": "get_get_contracts", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "TimeTracking \/ EmploymentContract" ], "summary": "Add a new EmploymentContract", "operationId": "post_post_contract", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "keepParallelContracts", "in": "query", "description": "Keep the earlier open contract of the person running in parallel instead of ending it the day before this contract starts (also accepted as employment_contract[keep_parallel_contracts])", "required": false, "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/employment\/contracts\/{id}": { "get": { "tags": [ "TimeTracking \/ EmploymentContract" ], "summary": "This method will get a single EmploymentContract with the given id", "operationId": "get_get_contract", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "TimeTracking \/ EmploymentContract" ], "summary": "Update a EmploymentContract", "operationId": "put_put_contract", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "keepParallelContracts", "in": "query", "description": "Keep the earlier open contract of the person running in parallel instead of ending it the day before this contract starts (also accepted as employment_contract[keep_parallel_contracts])", "required": false, "schema": { "type": "boolean" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "TimeTracking \/ EmploymentContract" ], "summary": "Update a EmploymentContract", "operationId": "patch_put_contract", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "keepParallelContracts", "in": "query", "description": "Keep the earlier open contract of the person running in parallel instead of ending it the day before this contract starts (also accepted as employment_contract[keep_parallel_contracts])", "required": false, "schema": { "type": "boolean" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/employment\/contracts\/{id}\/future_absences": { "get": { "tags": [ "TimeTracking \/ EmploymentContract" ], "summary": "R3: the vacations of the contract's person from a date on (default tomorrow) - shown\nbefore the working days of the contract change. Needs\nemployment_contract_future_absence_hint_enabled.", "operationId": "get_get_contract_future_absences", "parameters": [ { "name": "from", "in": "query", "description": "First day (Y-m-d), default tomorrow", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Not declined vacation requests from that day on: request_id, status, content_type, content_type_name, content_type_color, start, end, weekdays" } } } }, "\/api\/time\/employment\/leadership\/contracts\/{id}": { "put": { "tags": [ "TimeTracking \/ EmploymentContract" ], "summary": "Update a EmploymentContract as a leadership person of the contract", "operationId": "put_put_leadership_contract", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/employment\/leadership\/contracts": { "get": { "tags": [ "TimeTracking \/ EmploymentContract" ], "summary": "This method will get all EmploymentContract Objects with your leadership + your own contracts", "operationId": "get_get_leadership_contracts", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/employment\/contract_template": { "get": { "tags": [ "TimeTracking \/ EmploymentContractTemplate" ], "summary": "This method will get all EmploymentContractTemplate Objects", "operationId": "get_get_employment_contract_templates", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "templateType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "workTimeMode", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroup", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EmploymentContractTemplate objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentContractTemplate" } } } } } } }, "post": { "tags": [ "TimeTracking \/ EmploymentContractTemplate" ], "summary": "Add a new EmploymentContractTemplate", "operationId": "post_post_employment_contract_template", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentContractTemplate2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new EmploymentContractTemplate", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentContractTemplate" } } } } } } }, "\/api\/time\/employment\/contract_template\/{id}": { "get": { "tags": [ "TimeTracking \/ EmploymentContractTemplate" ], "summary": "This method will get a single EmploymentContractTemplate with the given id", "operationId": "get_get_employment_contract_template", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EmploymentContractTemplate", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentContractTemplate" } } } } } }, "put": { "tags": [ "TimeTracking \/ EmploymentContractTemplate" ], "summary": "Update a EmploymentContractTemplate", "operationId": "put_put_employment_contract_template", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentContractTemplate2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EmploymentContractTemplate", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentContractTemplate" } } } } } }, "patch": { "tags": [ "TimeTracking \/ EmploymentContractTemplate" ], "summary": "Update a EmploymentContractTemplate", "operationId": "patch_put_employment_contract_template", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentContractTemplate2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EmploymentContractTemplate", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentContractTemplate" } } } } } } }, "\/api\/time\/team_vacation_planner": { "get": { "tags": [ "TimeTracking \/ TeamVacationPlanner" ], "summary": "Wall chart data of a period: persons, their absences and the coverage per day", "operationId": "get_get_team_vacation_planner", "parameters": [ { "name": "from", "in": "query", "description": "First date (Y-m-d)", "required": true, "schema": { "type": "string" } }, { "name": "until", "in": "query", "description": "Last date (Y-m-d), at most 366 days after from", "required": true, "schema": { "type": "string" } }, { "name": "employment_contract_group", "in": "query", "description": "Limits the chart to one group", "required": false, "schema": { "type": "integer" } }, { "name": "template_type", "in": "query", "description": "Limits the chart to contracts of one category (template type, L22)", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Wall chart read model" } } } }, "\/api\/time\/non_work_time_request\/{id}\/pdf": { "get": { "tags": [ "TimeTracking \/ NonWorkTimeRequest" ], "summary": "The approved request as a printable document", "description": "The paper rule the digital request replaced still ends on paper: the approved\nrequest goes back to the team lead, and the employee gets a printout on request.\nWithdrawn days are named as withdrawn rather than merely missing - the rules ask for\nexactly that.", "operationId": "get_get_non_work_time_request_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PDF of the absence request" } } } }, "\/api\/time\/vacation_planning_status": { "get": { "tags": [ "TimeTracking \/ VacationPlanningStatus" ], "summary": "Planning status of a year: unplanned days per person", "operationId": "get_get_vacation_planning_status", "parameters": [ { "name": "year", "in": "query", "description": "Calendar year, defaults to the current one", "required": false, "schema": { "type": "integer" } }, { "name": "employment_contract_group", "in": "query", "description": "Limits the list to one group", "required": false, "schema": { "type": "integer" } }, { "name": "only_arrears", "in": "query", "description": "Only people with more open days than allowed", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Planning status per person" } } } }, "\/api\/time\/vacation_carry_over_approval": { "get": { "tags": [ "TimeTracking \/ VacationCarryOverApproval" ], "summary": "This method will get all VacationCarryOverApproval Objects", "operationId": "get_get_vacation_carry_over_approvals", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "year", "in": "query", "description": "The year the days come from - an approval for 2026 keeps days alive into 2027. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxDays", "in": "query", "description": "How many days may travel. null means everything that is left, which is what an unconditional approval says. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "approved", "in": "query", "description": "Approvals are entered by the people who may grant them, so a record exists because somebody decided - but a record that is prepared and not decided yet must not carry anything over, hence the explicit flag. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "approvedByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "approvedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "U06: the written flow. REQUESTED while the management has not decided; a record HR enters directly is APPROVED or DECLINED at once. null on legacy rows = derived from the approved flag. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requestedByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "decidedByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of VacationCarryOverApproval objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval" } } } } } } }, "post": { "tags": [ "TimeTracking \/ VacationCarryOverApproval" ], "summary": "Add a new VacationCarryOverApproval", "operationId": "post_post_vacation_carry_over_approval", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new VacationCarryOverApproval", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval3" } } } } } } }, "\/api\/time\/vacation_carry_over_approval\/request": { "post": { "tags": [ "TimeTracking \/ VacationCarryOverApproval" ], "summary": "U06: ask for a carry over in writing - the employee, their leads or HR", "operationId": "post_post_vacation_carry_over_approval_request", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Request a carry over of remaining vacation days", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval3" } } } } } } }, "\/api\/time\/vacation_carry_over_approval\/{id}\/decide": { "put": { "tags": [ "TimeTracking \/ VacationCarryOverApproval" ], "summary": "U06: the written decision of the management (organisation leadership) or HR", "operationId": "put_put_vacation_carry_over_approval_decide", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "decision", "in": "query", "description": "APPROVED or DECLINED", "required": true, "schema": { "type": "string", "enum": [ "APPROVED", "DECLINED" ] } }, { "name": "comment", "in": "query", "description": "The written decision", "required": true, "schema": { "type": "string" } }, { "name": "max_days", "in": "query", "description": "Cap the approved days (default: the requested days)", "required": false, "schema": { "type": "number" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Decide a carry over request in writing", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ VacationCarryOverApproval" ], "summary": "U06: the written decision of the management (organisation leadership) or HR", "operationId": "patch_put_vacation_carry_over_approval_decide", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "decision", "in": "query", "description": "APPROVED or DECLINED", "required": true, "schema": { "type": "string", "enum": [ "APPROVED", "DECLINED" ] } }, { "name": "comment", "in": "query", "description": "The written decision", "required": true, "schema": { "type": "string" } }, { "name": "max_days", "in": "query", "description": "Cap the approved days (default: the requested days)", "required": false, "schema": { "type": "number" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Decide a carry over request in writing", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval3" } } } } } } }, "\/api\/time\/vacation_carry_over_approval\/{id}": { "get": { "tags": [ "TimeTracking \/ VacationCarryOverApproval" ], "summary": "This method will get a single VacationCarryOverApproval with the given id", "operationId": "get_get_vacation_carry_over_approval", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single VacationCarryOverApproval", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval3" } } } } } }, "put": { "tags": [ "TimeTracking \/ VacationCarryOverApproval" ], "summary": "Update a VacationCarryOverApproval", "operationId": "put_put_vacation_carry_over_approval", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VacationCarryOverApproval", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ VacationCarryOverApproval" ], "summary": "Update a VacationCarryOverApproval", "operationId": "patch_put_vacation_carry_over_approval", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VacationCarryOverApproval", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationCarryOverApproval3" } } } } } } }, "\/api\/time\/vacation_expiry_notice": { "get": { "tags": [ "TimeTracking \/ VacationExpiryNotice" ], "summary": "This method will get all VacationExpiryNotice Objects - without HR or time reading rights the own ones", "operationId": "get_get_vacation_expiry_notices", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "year", "in": "query", "description": "Kalenderjahr des Hinweises - er entscheidet \u00fcber den Verfall des Resturlaubs aus dem Vorjahr in diesem Jahr. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sentAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "readAt", "in": "query", "description": "Lesebest\u00e4tigung der Person (oder von HR erfasst, z. B. f\u00fcr einen Hinweis auf Papier). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of VacationExpiryNotice objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/VacationExpiryNotice" } } } } } } }, "post": { "tags": [ "TimeTracking \/ VacationExpiryNotice" ], "summary": "Record a VacationExpiryNotice given outside vynst (HR)", "operationId": "post_post_vacation_expiry_notice", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VacationExpiryNotice2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Record a VacationExpiryNotice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationExpiryNotice" } } } } } } }, "\/api\/time\/vacation_expiry_notice\/{id}\/read": { "put": { "tags": [ "TimeTracking \/ VacationExpiryNotice" ], "summary": "The person confirms having read the notice on remaining vacation and its expiry", "description": "Only the person the notice is addressed to can confirm it; a second confirmation keeps\nthe first date.", "operationId": "put_put_vacation_expiry_notice_read", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Confirm having read a VacationExpiryNotice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationExpiryNotice" } } } } } }, "post": { "tags": [ "TimeTracking \/ VacationExpiryNotice" ], "summary": "The person confirms having read the notice on remaining vacation and its expiry", "description": "Only the person the notice is addressed to can confirm it; a second confirmation keeps\nthe first date.", "operationId": "post_put_vacation_expiry_notice_read", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Confirm having read a VacationExpiryNotice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationExpiryNotice" } } } } } }, "patch": { "tags": [ "TimeTracking \/ VacationExpiryNotice" ], "summary": "The person confirms having read the notice on remaining vacation and its expiry", "description": "Only the person the notice is addressed to can confirm it; a second confirmation keeps\nthe first date.", "operationId": "patch_put_vacation_expiry_notice_read", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Confirm having read a VacationExpiryNotice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationExpiryNotice" } } } } } } }, "\/api\/time\/vacation_expiry_notice\/{id}": { "get": { "tags": [ "TimeTracking \/ VacationExpiryNotice" ], "summary": "This method will get a single VacationExpiryNotice with the given id", "operationId": "get_get_vacation_expiry_notice", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single VacationExpiryNotice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationExpiryNotice" } } } } } }, "put": { "tags": [ "TimeTracking \/ VacationExpiryNotice" ], "summary": "Update a VacationExpiryNotice (HR)", "operationId": "put_put_vacation_expiry_notice", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VacationExpiryNotice2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VacationExpiryNotice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationExpiryNotice" } } } } } }, "patch": { "tags": [ "TimeTracking \/ VacationExpiryNotice" ], "summary": "Update a VacationExpiryNotice (HR)", "operationId": "patch_put_vacation_expiry_notice", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VacationExpiryNotice2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VacationExpiryNotice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VacationExpiryNotice" } } } } } } }, "\/api\/time\/shift_plan_entry\/pdf": { "get": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "Printable week plan as PDF - the three scopes of the requirement are covered by the\noptional person \/ group filter, everything else stays the same document", "operationId": "get_get_shift_plan_pdf", "parameters": [ { "name": "from", "in": "query", "description": "First date (Y-m-d)", "required": true, "schema": { "type": "string" } }, { "name": "until", "in": "query", "description": "Last date (Y-m-d), at most 62 days after from", "required": true, "schema": { "type": "string" } }, { "name": "employment_contract_group", "in": "query", "description": "Group scope", "required": false, "schema": { "type": "integer" } }, { "name": "employment_organization", "in": "query", "description": "Organization scope (without a group): the shifts of every group of the organization", "required": false, "schema": { "type": "integer" } }, { "name": "person", "in": "query", "description": "Person scope", "required": false, "schema": { "type": "integer" } }, { "name": "include_bookings", "in": "query", "description": "Default 1 - print the appointments of the printed persons as well (L23)", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "PDF of the published plan" } } } }, "\/api\/time\/shift_plan_entry\/timeline": { "get": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "R06: the combined plan of a group, an organization or one person - shifts, the\nappointments the persons are responsible for, absences and the conflicts between\nthem, per person and window (L25\/L28\/L29\/L32\/L33).", "operationId": "get_get_shift_plan_timeline", "parameters": [ { "name": "from", "in": "query", "description": "First date (Y-m-d)", "required": true, "schema": { "type": "string" } }, { "name": "until", "in": "query", "description": "Last date (Y-m-d), at most 62 days after from", "required": true, "schema": { "type": "string" } }, { "name": "employment_contract_group", "in": "query", "description": "Group scope", "required": false, "schema": { "type": "integer" } }, { "name": "employment_organization", "in": "query", "description": "Organization scope", "required": false, "schema": { "type": "integer" } }, { "name": "person", "in": "query", "description": "Single person scope (own plan, or a person one leads)", "required": false, "schema": { "type": "integer" } }, { "name": "persons", "in": "query", "description": "Comma separated person ids to restrict the rows (L29)", "required": false, "schema": { "type": "string" } }, { "name": "include_bookings", "in": "query", "description": "Default 1", "required": false, "schema": { "type": "boolean" } }, { "name": "include_availability", "in": "query", "description": "Default 1 - availability bookings shaded (L32)", "required": false, "schema": { "type": "boolean" } }, { "name": "include_other_contexts", "in": "query", "description": "Default 0 - also the persons' shifts of other groups (L29)", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/shift_plan_entry\/plannable_groups": { "get": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "The groups the current session may plan - the group choice of the week view. A\nglobal planner gets every active group, a team lead the groups they lead. Only id\nand name: the general group list (with costs and hours) stays closed to team leads.", "operationId": "get_get_shift_plan_plannable_groups", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Plannable groups, sorted by name", "content": { "application\/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" } } } } } } } }, "\/api\/time\/shift_plan_entry\/coverage": { "get": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "Staffing coverage of a date range - the data source of the planning grid and of the\nmeeting vacation planner", "operationId": "get_get_shift_plan_coverage", "parameters": [ { "name": "from", "in": "query", "description": "First date (Y-m-d)", "required": true, "schema": { "type": "string" } }, { "name": "until", "in": "query", "description": "Last date (Y-m-d), at most 62 days after from", "required": true, "schema": { "type": "string" } }, { "name": "employment_contract_group", "in": "query", "description": "Limits the check to one planning group - required for a team lead without global time rights", "required": false, "schema": { "type": "integer" } }, { "name": "employment_organization", "in": "query", "description": "Without a group: the rules of the organisation, of its groups and the installation wide ones (a team lead sees the rules of the own groups)", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Coverage per requirement and date" } } } }, "\/api\/time\/shift_plan_template\/publish_week": { "post": { "tags": [ "TimeTracking \/ ShiftPlanTemplate" ], "summary": "Publishes a whole week in one transaction - all or nothing", "operationId": "post_post_shift_plan_publish_week", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startMonth", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startYear", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroup", "in": "query", "description": "Planning container - mandatory even when a person of another group helps out. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shiftType", "in": "query", "description": "Origin type - times were copied, the reference is informational. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contract", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the published ShiftPlanEntry objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShiftPlanEntry" } } } } } } } }, "\/api\/time\/shift_plan_template\/copy_week": { "post": { "tags": [ "TimeTracking \/ ShiftPlanTemplate" ], "summary": "Copies all shifts of one week into another week as DRAFT shifts", "operationId": "post_post_shift_plan_copy_week", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startMonth", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startYear", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroup", "in": "query", "description": "Planning container - mandatory even when a person of another group helps out. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shiftType", "in": "query", "description": "Origin type - times were copied, the reference is informational. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contract", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the created ShiftPlanEntry objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShiftPlanEntry" } } } } } } } }, "\/api\/time\/shift_plan_template\/{id}\/apply": { "post": { "tags": [ "TimeTracking \/ ShiftPlanTemplate" ], "summary": "Applies a week template to a week - creates open DRAFT shifts, never touches\nexisting ones", "operationId": "post_post_shift_plan_template_apply", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startMonth", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startYear", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroup", "in": "query", "description": "Planning container - mandatory even when a person of another group helps out. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shiftType", "in": "query", "description": "Origin type - times were copied, the reference is informational. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contract", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the created ShiftPlanEntry objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShiftPlanEntry" } } } } } } } }, "\/api\/time\/shift_plan_template": { "get": { "tags": [ "TimeTracking \/ ShiftPlanTemplate" ], "summary": "This method will get all ShiftPlanTemplate Objects", "operationId": "get_get_shift_plan_templates", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroup", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of ShiftPlanTemplate objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShiftPlanTemplate" } } } } } } }, "post": { "tags": [ "TimeTracking \/ ShiftPlanTemplate" ], "summary": "Add a new ShiftPlanTemplate", "operationId": "post_post_shift_plan_template", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftPlanTemplate2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ShiftPlanTemplate", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftPlanTemplate3" } } } } } } }, "\/api\/time\/shift_plan_template\/{id}": { "get": { "tags": [ "TimeTracking \/ ShiftPlanTemplate" ], "summary": "This method will get a single ShiftPlanTemplate with the given id", "operationId": "get_get_shift_plan_template", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single ShiftPlanTemplate", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftPlanTemplate3" } } } } } }, "put": { "tags": [ "TimeTracking \/ ShiftPlanTemplate" ], "summary": "Update a ShiftPlanTemplate", "operationId": "put_put_shift_plan_template", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftPlanTemplate2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a ShiftPlanTemplate", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftPlanTemplate3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ ShiftPlanTemplate" ], "summary": "Update a ShiftPlanTemplate", "operationId": "patch_put_shift_plan_template", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftPlanTemplate2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a ShiftPlanTemplate", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftPlanTemplate3" } } } } } } }, "\/api\/time\/staffing_coverage_alarm\/{id}": { "get": { "tags": [ "TimeTracking \/ StaffingCoverageAlarm" ], "summary": "Get a single StaffingCoverageAlarm", "operationId": "get_get_staffing_coverage_alarm", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StaffingCoverageAlarm", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StaffingCoverageAlarm" } } } } } }, "put": { "tags": [ "TimeTracking \/ StaffingCoverageAlarm" ], "summary": "Acknowledge an alarm (the office has seen it and is dealing with it)", "operationId": "put_put_staffing_coverage_alarm", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StaffingCoverageAlarm2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Acknowledge a StaffingCoverageAlarm", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StaffingCoverageAlarm" } } } } } }, "patch": { "tags": [ "TimeTracking \/ StaffingCoverageAlarm" ], "summary": "Acknowledge an alarm (the office has seen it and is dealing with it)", "operationId": "patch_put_staffing_coverage_alarm", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StaffingCoverageAlarm2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Acknowledge a StaffingCoverageAlarm", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StaffingCoverageAlarm" } } } } } } }, "\/api\/time\/staffing_coverage_alarm": { "get": { "tags": [ "TimeTracking \/ StaffingCoverageAlarm" ], "summary": "List StaffingCoverageAlarm objects (open ones by default: pass resolved_at=null or a status filter)", "operationId": "get_get_staffing_coverage_alarms", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "requirement", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "WORKER (daily scan) or APPROVAL (an approval dropped the day below the minimum). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "notifiedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "resolvedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "acknowledgedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "request", "in": "query", "description": "The request whose approval raised the alarm, when it was one (L54). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StaffingCoverageAlarm objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StaffingCoverageAlarm3" } } } } } } } }, "\/api\/time\/staffing_requirement": { "get": { "tags": [ "TimeTracking \/ StaffingRequirement" ], "summary": "This method will get all StaffingRequirement Objects", "operationId": "get_get_staffing_requirements", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bufferMode", "in": "query", "description": "L53: HINT (default) submits with a hint, BLOCK refuses a self service request that would drop the day below minimum + buffer. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroup", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentOrganization", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "organizationUnit", "in": "query", "description": "R7: a rule for a whole area (OrganizationUnit) - every group of every organisation in it or below it. Only without group and organisation, with staffing_organization_unit_enabled. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requiredQualification", "in": "query", "description": "Optional qualification the counted people have to satisfy (equivalences and ranking are honoured by QualificationMatchHelper). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StaffingRequirement objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StaffingRequirement" } } } } } } }, "post": { "tags": [ "TimeTracking \/ StaffingRequirement" ], "summary": "Add a new StaffingRequirement", "operationId": "post_post_staffing_requirement", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StaffingRequirement2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new StaffingRequirement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StaffingRequirement3" } } } } } } }, "\/api\/time\/staffing_requirement\/{id}": { "get": { "tags": [ "TimeTracking \/ StaffingRequirement" ], "summary": "This method will get a single StaffingRequirement with the given id", "operationId": "get_get_staffing_requirement", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StaffingRequirement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StaffingRequirement3" } } } } } }, "put": { "tags": [ "TimeTracking \/ StaffingRequirement" ], "summary": "Update a StaffingRequirement", "operationId": "put_put_staffing_requirement", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StaffingRequirement2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a StaffingRequirement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StaffingRequirement3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ StaffingRequirement" ], "summary": "Update a StaffingRequirement", "operationId": "patch_put_staffing_requirement", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/StaffingRequirement2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a StaffingRequirement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StaffingRequirement3" } } } } } } }, "\/api\/time\/non_work_time_blocking_period": { "get": { "tags": [ "TimeTracking \/ NonWorkTimeBlockingPeriod" ], "summary": "This method will get all NonWorkTimeBlockingPeriod Objects", "operationId": "get_get_non_work_time_blocking_periods", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "scope", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxDaysPerYear", "in": "query", "description": "Days per calendar year that may still be taken inside this period before it decides anything at all. null keeps the period absolute - the previous and still default behaviour. A value turns the period from a wall into an allowance: \"at most seven days outside the school holidays\" is one period over the whole year with a quota of seven, not seven separate rules. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "quotaScope", "in": "query", "description": "Which days inside the period count towards the quota. Only meaningful together with maxDaysPerYear. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requiresConsultation", "in": "query", "description": "Days this period counts (e.g. outside school holidays) may only be requested after a consultation with the responsible team lead; the request has to name it (U14). | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "cancellationQuotaDays", "in": "query", "description": "U21: how many already approved absence days a person may withdraw again inside this period per year (e.g. two days of the summer closure). null = no limit. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "cancellationRequiresWrittenApproval", "in": "query", "description": "U21: withdrawing approved days inside this period needs the written decision of the management step (comment mandatory). | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "start", "in": "query", "description": "First blocked day (inclusive). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "description": "Last blocked day (inclusive) - a one day block has start = end. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroup", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentOrganization", "in": "query", "description": "All three references empty means the period applies to everyone. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contract", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of NonWorkTimeBlockingPeriod objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeBlockingPeriod" } } } } } } }, "post": { "tags": [ "TimeTracking \/ NonWorkTimeBlockingPeriod" ], "summary": "Add a new NonWorkTimeBlockingPeriod", "operationId": "post_post_non_work_time_blocking_period", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeBlockingPeriod2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new NonWorkTimeBlockingPeriod", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeBlockingPeriod3" } } } } } } }, "\/api\/time\/non_work_time_blocking_period\/{id}": { "get": { "tags": [ "TimeTracking \/ NonWorkTimeBlockingPeriod" ], "summary": "This method will get a single NonWorkTimeBlockingPeriod with the given id", "operationId": "get_get_non_work_time_blocking_period", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single NonWorkTimeBlockingPeriod", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeBlockingPeriod3" } } } } } }, "put": { "tags": [ "TimeTracking \/ NonWorkTimeBlockingPeriod" ], "summary": "Update a NonWorkTimeBlockingPeriod", "operationId": "put_put_non_work_time_blocking_period", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeBlockingPeriod2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a NonWorkTimeBlockingPeriod", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeBlockingPeriod3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ NonWorkTimeBlockingPeriod" ], "summary": "Update a NonWorkTimeBlockingPeriod", "operationId": "patch_put_non_work_time_blocking_period", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeBlockingPeriod2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a NonWorkTimeBlockingPeriod", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeBlockingPeriod3" } } } } } } }, "\/api\/time\/non_work_time_plan_selection_type": { "get": { "tags": [ "TimeTracking \/ NonWorkTimePlanSelectionType" ], "summary": "This method will get all NonWorkTimePlanSelectionType Objects", "operationId": "get_get_non_work_time_plan_selection_types", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "priority", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isVacation", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "isSick", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "selectableForRequest", "in": "query", "description": "Whether a new absence request may be created with this type. Types that only describe a day in an overview - holiday, school holiday, work day - are not offered in the editors. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "statusChangeRequiresHrApproval", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "requiresManagementApproval", "in": "query", "description": "Requests of this type need a final written decision by the management (the organization leadership), appended after the regular approval chain (U10). | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "maxDaysPerRequest", "in": "query", "description": "Upper limit of calendar days one request of this type may cover; null = unlimited. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of NonWorkTimePlanSelectionType objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType" } } } } } } }, "post": { "tags": [ "TimeTracking \/ NonWorkTimePlanSelectionType" ], "summary": "Add a new NonWorkTimePlanSelectionType", "operationId": "post_post_non_work_time_plan_selection_type", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new NonWorkTimePlanSelectionType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType" } } } } } } }, "\/api\/time\/non_work_time_plan_selection_type\/{id}": { "get": { "tags": [ "TimeTracking \/ NonWorkTimePlanSelectionType" ], "summary": "This method will get a single NonWorkTimePlanSelectionType with the given id", "operationId": "get_get_non_work_time_plan_selection_type", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single NonWorkTimePlanSelectionType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType" } } } } } }, "put": { "tags": [ "TimeTracking \/ NonWorkTimePlanSelectionType" ], "summary": "Update a NonWorkTimePlanSelectionType", "operationId": "put_put_non_work_time_plan_selection_type", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a NonWorkTimePlanSelectionType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType" } } } } } }, "patch": { "tags": [ "TimeTracking \/ NonWorkTimePlanSelectionType" ], "summary": "Update a NonWorkTimePlanSelectionType", "operationId": "patch_put_non_work_time_plan_selection_type", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a NonWorkTimePlanSelectionType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType" } } } } } } }, "\/api\/time\/employment_contract_change_request": { "get": { "tags": [ "TimeTracking \/ EmploymentContractChangeRequest" ], "summary": "This method will get all EmploymentContractChangeRequest Objects. Without HR read access a\nlead gets the requests of the contracts they lead; with the contract parameter the caller\nhas to lead (or own) that contract.", "operationId": "get_get_employment_contract_change_requests", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "contract", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "First day the new distribution applies; always a month start beyond the change deadline. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requestedByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requestedByPerson", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "decidedByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "autoApplied", "in": "query", "description": "True when the confirmation happened without an HR decision (unchanged weekly total, installation setting). | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EmploymentContractChangeRequest objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentContractChangeRequest" } } } } } } }, "post": { "tags": [ "TimeTracking \/ EmploymentContractChangeRequest" ], "summary": "Hand in a change request for the weekly working days of a contract", "operationId": "post_post_employment_contract_change_request", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentContractChangeRequest2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new EmploymentContractChangeRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentContractChangeRequest3" } } } } } } }, "\/api\/time\/employment_contract_change_request\/{id}": { "get": { "tags": [ "TimeTracking \/ EmploymentContractChangeRequest" ], "summary": "This method will get a single EmploymentContractChangeRequest with the given id", "operationId": "get_get_employment_contract_change_request", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EmploymentContractChangeRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentContractChangeRequest3" } } } } } }, "put": { "tags": [ "TimeTracking \/ EmploymentContractChangeRequest" ], "summary": "Decide a change request (HR): status APPROVED applies it as a dated contract change, DECLINED closes it", "operationId": "put_put_employment_contract_change_request", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentContractChangeRequest2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Decide an EmploymentContractChangeRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentContractChangeRequest3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ EmploymentContractChangeRequest" ], "summary": "Decide a change request (HR): status APPROVED applies it as a dated contract change, DECLINED closes it", "operationId": "patch_put_employment_contract_change_request", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentContractChangeRequest2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Decide an EmploymentContractChangeRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentContractChangeRequest3" } } } } } } }, "\/api\/time\/employment\/qualification_group": { "get": { "tags": [ "TimeTracking \/ EmploymentQualificationGroup" ], "summary": "This method will get all EmploymentQualificationGroup Objects", "operationId": "get_get_employment_qualification_groups", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Order in pickers and legends. | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EmploymentQualificationGroup objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } } } } } } }, "post": { "tags": [ "TimeTracking \/ EmploymentQualificationGroup" ], "summary": "Add a new EmploymentQualificationGroup", "operationId": "post_post_employment_qualification_group", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new EmploymentQualificationGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } } } } } } }, "\/api\/time\/employment\/qualification_group\/{id}": { "get": { "tags": [ "TimeTracking \/ EmploymentQualificationGroup" ], "summary": "This method will get a single EmploymentQualificationGroup with the given id", "operationId": "get_get_employment_qualification_group", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EmploymentQualificationGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } } } } } }, "put": { "tags": [ "TimeTracking \/ EmploymentQualificationGroup" ], "summary": "Update a EmploymentQualificationGroup", "operationId": "put_put_employment_qualification_group", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EmploymentQualificationGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } } } } } }, "patch": { "tags": [ "TimeTracking \/ EmploymentQualificationGroup" ], "summary": "Update a EmploymentQualificationGroup", "operationId": "patch_put_employment_qualification_group", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EmploymentQualificationGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } } } } } } }, "\/api\/time\/school_holiday_region": { "get": { "tags": [ "TimeTracking \/ SchoolHolidayRegion" ], "summary": "This method will get all SchoolHolidayRegion Objects", "operationId": "get_get_school_holiday_regions", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "regionCode", "in": "query", "description": "Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Order in pickers. | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of SchoolHolidayRegion objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } } } } } } }, "post": { "tags": [ "TimeTracking \/ SchoolHolidayRegion" ], "summary": "Add a new SchoolHolidayRegion", "operationId": "post_post_school_holiday_region", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SchoolHolidayRegion2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new SchoolHolidayRegion", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } } } } } } }, "\/api\/time\/school_holiday_region\/{id}": { "get": { "tags": [ "TimeTracking \/ SchoolHolidayRegion" ], "summary": "This method will get a single SchoolHolidayRegion with the given id", "operationId": "get_get_school_holiday_region", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single SchoolHolidayRegion", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } } } } } }, "put": { "tags": [ "TimeTracking \/ SchoolHolidayRegion" ], "summary": "Update a SchoolHolidayRegion", "operationId": "put_put_school_holiday_region", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SchoolHolidayRegion2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a SchoolHolidayRegion", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } } } } } }, "patch": { "tags": [ "TimeTracking \/ SchoolHolidayRegion" ], "summary": "Update a SchoolHolidayRegion", "operationId": "patch_put_school_holiday_region", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SchoolHolidayRegion2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a SchoolHolidayRegion", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } } } } } } }, "\/api\/time\/organization_unit": { "get": { "tags": [ "TimeTracking \/ OrganizationUnit" ], "summary": "This method will get all OrganizationUnit Objects", "operationId": "get_get_organization_units", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "level", "in": "query", "description": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Order among siblings. | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of OrganizationUnit objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrganizationUnit" } } } } } } }, "post": { "tags": [ "TimeTracking \/ OrganizationUnit" ], "summary": "Add a new OrganizationUnit", "operationId": "post_post_organization_unit", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OrganizationUnit2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new OrganizationUnit", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrganizationUnit3" } } } } } } }, "\/api\/time\/organization_unit\/tree": { "get": { "tags": [ "TimeTracking \/ OrganizationUnit" ], "summary": "The whole organisation tree: units with child units, organisations and groups, plus a\nvirtual node for organisations not sorted into the tree yet. Only HR reads all of it;\nleaders get their own part of the structure, everybody else an empty list.", "operationId": "get_get_organization_unit_tree", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Nested tree of units, organisations and groups" } } } }, "\/api\/time\/organization_unit\/{id}": { "get": { "tags": [ "TimeTracking \/ OrganizationUnit" ], "summary": "This method will get a single OrganizationUnit with the given id", "operationId": "get_get_organization_unit", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns a single OrganizationUnit", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrganizationUnit3" } } } } } }, "put": { "tags": [ "TimeTracking \/ OrganizationUnit" ], "summary": "Update a OrganizationUnit", "operationId": "put_put_organization_unit", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OrganizationUnit2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a OrganizationUnit", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrganizationUnit3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ OrganizationUnit" ], "summary": "Update a OrganizationUnit", "operationId": "patch_put_organization_unit", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OrganizationUnit2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a OrganizationUnit", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrganizationUnit3" } } } } } } }, "\/api\/time\/organization_broadcast": { "post": { "tags": [ "TimeTracking \/ OrganizationBroadcast" ], "summary": "Send a broadcast to the people of a unit, organisation or group", "description": "Body (`data`): target_type (UNIT|ORGANIZATION|GROUP), target_id, text (subject\/short),\nlong_text (body), send_push, send_mail. Query `dry_run=1` only resolves the recipients.", "operationId": "post_post_organization_broadcast", "parameters": [ { "name": "dry_run", "in": "query", "description": "Only list the recipients, send nothing", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "target_type": { "type": "string", "enum": [ "UNIT", "ORGANIZATION", "GROUP" ] }, "target_id": { "type": "integer" }, "text": { "type": "string" }, "long_text": { "type": "string" }, "send_push": { "type": "boolean" }, "send_mail": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Recipients and, unless dry run, the queued mass notification" } } } }, "\/api\/time\/shift_type": { "get": { "tags": [ "TimeTracking \/ ShiftType" ], "summary": "This method will get all ShiftType Objects", "operationId": "get_get_shift_types", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroup", "in": "query", "description": "Group this type belongs to (null = available for the whole organization \/ installation). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentOrganization", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requiredQualification", "in": "query", "description": "Default qualification requirement for shifts of this type. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of ShiftType objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShiftType" } } } } } } }, "post": { "tags": [ "TimeTracking \/ ShiftType" ], "summary": "Add a new ShiftType", "operationId": "post_post_shift_type", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ShiftType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftType3" } } } } } } }, "\/api\/time\/shift_type\/{id}": { "get": { "tags": [ "TimeTracking \/ ShiftType" ], "summary": "This method will get a single ShiftType with the given id", "operationId": "get_get_shift_type", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single ShiftType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftType3" } } } } } }, "put": { "tags": [ "TimeTracking \/ ShiftType" ], "summary": "Update a ShiftType", "operationId": "put_put_shift_type", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a ShiftType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftType3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ ShiftType" ], "summary": "Update a ShiftType", "operationId": "patch_put_shift_type", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a ShiftType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftType3" } } } } } } }, "\/api\/time\/shift_plan_entry\/own": { "get": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "This method will get the published shifts of the current user", "operationId": "get_get_own_shift_plan_entries", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startMonth", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startYear", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroup", "in": "query", "description": "Planning container - mandatory even when a person of another group helps out. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shiftType", "in": "query", "description": "Origin type - times were copied, the reference is informational. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contract", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the own published ShiftPlanEntry objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShiftPlanEntry" } } } } } } } }, "\/api\/time\/shift_plan_entry\/{id}\/booking": { "post": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "L35: create an appointment from a shift - time and person from the shift, room,\nlocation and type from the body. Only where the shift booking sync is enabled for the\ncontract, group or organisation.", "operationId": "post_post_shift_plan_entry_booking", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "name": { "type": "string" }, "base_bookable": { "type": "integer" }, "base_location": { "type": "integer" }, "content_type": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The created appointment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking" } } } } } } }, "\/api\/time\/shift_plan_entry\/{id}\/clock_in": { "post": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "L38: start the work time at this shift with the real clock time", "operationId": "post_post_shift_plan_entry_clock_in", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Start a work time entry for the own shift", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntry" } } } } } } }, "\/api\/time\/shift_plan_entry\/{id}\/clock_out": { "post": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "L38: end the running work time at this shift with the real clock time", "operationId": "post_post_shift_plan_entry_clock_out", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "End the running work time entry of the own shift", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntry" } } } } } } }, "\/api\/time\/work_time_entry_correction_request": { "get": { "tags": [ "TimeTracking \/ WorkTimeEntryCorrectionRequest" ], "summary": "List correction requests (own ones without a filter, a team with user\/person filters)", "operationId": "get_get_work_time_entry_correction_requests", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "workTimeEntry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requestedByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "decidedByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of WorkTimeEntryCorrectionRequest objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorkTimeEntryCorrectionRequest" } } } } } } }, "post": { "tags": [ "TimeTracking \/ WorkTimeEntryCorrectionRequest" ], "summary": "Hand in a correction of a work time entry (old values are frozen by the server)", "operationId": "post_post_work_time_entry_correction_request", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/WorkTimeEntryCorrectionRequest2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Request a correction of a work time entry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntryCorrectionRequest3" } } } } } } }, "\/api\/time\/work_time_entry_correction_request\/{id}\/decide": { "put": { "tags": [ "TimeTracking \/ WorkTimeEntryCorrectionRequest" ], "summary": "Decide a correction: approve applies the new values to the entry, decline keeps it", "operationId": "put_put_work_time_entry_correction_request_decide", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "decision", "in": "query", "description": "APPROVED or DECLINED", "required": true, "schema": { "type": "string", "enum": [ "APPROVED", "DECLINED" ] } }, { "name": "comment", "in": "query", "description": "Optional decision comment", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Approve or decline a correction request", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntryCorrectionRequest3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ WorkTimeEntryCorrectionRequest" ], "summary": "Decide a correction: approve applies the new values to the entry, decline keeps it", "operationId": "patch_put_work_time_entry_correction_request_decide", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "decision", "in": "query", "description": "APPROVED or DECLINED", "required": true, "schema": { "type": "string", "enum": [ "APPROVED", "DECLINED" ] } }, { "name": "comment", "in": "query", "description": "Optional decision comment", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Approve or decline a correction request", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntryCorrectionRequest3" } } } } } } }, "\/api\/time\/work_time_entry_correction_request\/{id}": { "get": { "tags": [ "TimeTracking \/ WorkTimeEntryCorrectionRequest" ], "summary": "Get a single correction request", "operationId": "get_get_work_time_entry_correction_request", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single WorkTimeEntryCorrectionRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntryCorrectionRequest3" } } } } } } }, "\/api\/time\/shift_exchange_request\/available": { "get": { "tags": [ "TimeTracking \/ ShiftExchangeRequest" ], "summary": "Returns the available entries.", "operationId": "get_time_shift_exchange_available", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string", "example": "2026-09" } }, { "name": "after_id", "in": "query", "schema": { "type": "integer" } }, { "name": "other_groups", "in": "query", "description": "Also shifts and offers of other groups (own group first), when the installation allows it", "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Eligible open published shifts; follow next_after_id even when the filtered page is empty", "content": { "application\/json": { "schema": { "properties": { "available": { "type": "array", "items": { "properties": { "shift": { "$ref": "#\/components\/schemas\/ShiftPlanEntry" }, "contracts": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "number": { "type": "string", "nullable": true } }, "type": "object" } }, "own_group": { "type": "boolean" }, "hints": { "type": "array", "items": { "type": "string" } } }, "type": "object" } }, "next_after_id": { "type": "integer", "nullable": true } }, "type": "object" } } } } } } }, "\/api\/time\/shift_exchange_request": { "get": { "tags": [ "TimeTracking \/ ShiftExchangeRequest" ], "summary": "Returns a list of shift exchange request entries.", "operationId": "get_time_shift_exchange_request_cget", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string", "example": "2026-09" } }, { "name": "before_id", "in": "query", "schema": { "type": "integer" } }, { "name": "other_groups", "in": "query", "description": "Also shifts and offers of other groups (own group first), when the installation allows it", "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Visible exchanges and own history; follow next_before_id even when the filtered page is empty", "content": { "application\/json": { "schema": { "properties": { "requests": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShiftExchangeRequest" } }, "next_before_id": { "type": "integer", "nullable": true } }, "type": "object" } } } } } }, "post": { "tags": [ "TimeTracking \/ ShiftExchangeRequest" ], "summary": "Creates a new shift exchange request entry.", "operationId": "post_time_shift_exchange_request_post", "parameters": [ { "name": "source_version", "in": "query", "schema": { "type": "integer" } }, { "name": "other_groups", "in": "query", "description": "Also shifts and offers of other groups (own group first), when the installation allows it", "schema": { "type": "boolean" } }, { "name": "contract_id", "in": "query", "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftExchangeRequest" } }, "type": "object" } } } }, "responses": { "200": { "description": "Offer or claim a shift", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftExchangeRequest2" } } } } } } }, "\/api\/time\/shift_exchange_request\/{id}": { "get": { "tags": [ "TimeTracking \/ ShiftExchangeRequest" ], "summary": "Returns a single shift exchange request entry.", "operationId": "get_time_shift_exchange_request_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Read a visible exchange", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftExchangeRequest2" } } } } } }, "put": { "tags": [ "TimeTracking \/ ShiftExchangeRequest" ], "summary": "Updates an existing shift exchange request entry.", "operationId": "put_time_shift_exchange_request_put", "parameters": [ { "name": "action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "PROPOSE", "CONFIRM", "APPROVE", "DECLINE", "CANCEL" ] } }, { "name": "lock_version", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "target_shift", "in": "query", "schema": { "type": "integer" } }, { "name": "target_version", "in": "query", "schema": { "type": "integer" } }, { "name": "contract_id", "in": "query", "schema": { "type": "integer" } }, { "name": "owner_contract_id", "in": "query", "schema": { "type": "integer" } }, { "name": "other_groups", "in": "query", "description": "Also shifts and offers of other groups (own group first), when the installation allows it", "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftExchangeRequest" } }, "type": "object" } } } }, "responses": { "200": { "description": "Confirm or decide an exchange", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftExchangeRequest2" } } } } } }, "delete": { "tags": [ "TimeTracking \/ ShiftExchangeRequest" ], "summary": "Deletes a shift exchange request entry.", "operationId": "delete_time_shift_exchange_request_delete", "parameters": [ { "name": "lock_version", "in": "query", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cancel an own active exchange; history is retained", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftExchangeRequest2" } } } } } }, "patch": { "tags": [ "TimeTracking \/ ShiftExchangeRequest" ], "summary": "Updates an existing shift exchange request entry.", "operationId": "patch_time_shift_exchange_request_put", "parameters": [ { "name": "action", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "PROPOSE", "CONFIRM", "APPROVE", "DECLINE", "CANCEL" ] } }, { "name": "lock_version", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "target_shift", "in": "query", "schema": { "type": "integer" } }, { "name": "target_version", "in": "query", "schema": { "type": "integer" } }, { "name": "contract_id", "in": "query", "schema": { "type": "integer" } }, { "name": "owner_contract_id", "in": "query", "schema": { "type": "integer" } }, { "name": "other_groups", "in": "query", "description": "Also shifts and offers of other groups (own group first), when the installation allows it", "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftExchangeRequest" } }, "type": "object" } } } }, "responses": { "200": { "description": "Confirm or decide an exchange", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftExchangeRequest2" } } } } } } }, "\/api\/time\/shift_plan_entry": { "get": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "This method will get all ShiftPlanEntry Objects the current user may plan", "operationId": "get_get_shift_plan_entries", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "startDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startMonth", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startYear", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroup", "in": "query", "description": "Planning container - mandatory even when a person of another group helps out. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shiftType", "in": "query", "description": "Origin type - times were copied, the reference is informational. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contract", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of ShiftPlanEntry objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShiftPlanEntry" } } } } } } }, "post": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "Add a new ShiftPlanEntry", "operationId": "post_post_shift_plan_entry", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftPlanEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ShiftPlanEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftPlanEntry3" } } } } } } }, "\/api\/time\/shift_plan_entry\/{id}": { "get": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "This method will get a single ShiftPlanEntry with the given id", "operationId": "get_get_shift_plan_entry", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single ShiftPlanEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftPlanEntry3" } } } } } }, "put": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "Update a ShiftPlanEntry", "operationId": "put_put_shift_plan_entry", "parameters": [ { "name": "status", "in": "query", "description": "New lifecycle status (DRAFT, PUBLISHED, CANCELLED) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "lock_version", "in": "query", "description": "Version the client last saw - a mismatch answers 409 instead of overwriting", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftPlanEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a ShiftPlanEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftPlanEntry3" } } } } } }, "delete": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "Delete a ShiftPlanEntry - a draft disappears, a published shift is called off\n(CANCELLED, the team is told) so the plan keeps its history", "operationId": "delete_delete_shift_plan_entry", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a draft or cancel a published ShiftPlanEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftPlanEntry3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ ShiftPlanEntry" ], "summary": "Update a ShiftPlanEntry", "operationId": "patch_put_shift_plan_entry", "parameters": [ { "name": "status", "in": "query", "description": "New lifecycle status (DRAFT, PUBLISHED, CANCELLED) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "lock_version", "in": "query", "description": "Version the client last saw - a mismatch answers 409 instead of overwriting", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShiftPlanEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a ShiftPlanEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShiftPlanEntry3" } } } } } } }, "\/api\/time\/employment\/qualification": { "get": { "tags": [ "TimeTracking \/ EmploymentQualification" ], "summary": "This method will get all EmploymentQualification Objects", "operationId": "get_get_employment_qualifications", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "ranking", "in": "query", "description": "Ranking within an equivalence network - a linked qualification with a higher or equal ranking also satisfies requirements for this qualification. | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EmploymentQualification objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification" } } } } } } }, "post": { "tags": [ "TimeTracking \/ EmploymentQualification" ], "summary": "Add a new EmploymentQualification", "operationId": "post_post_employment_qualification", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentQualification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new EmploymentQualification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentQualification" } } } } } } }, "\/api\/time\/employment\/qualification\/{id}": { "get": { "tags": [ "TimeTracking \/ EmploymentQualification" ], "summary": "This method will get a single EmploymentQualification with the given id", "operationId": "get_get_employment_qualification", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EmploymentQualification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentQualification" } } } } } }, "put": { "tags": [ "TimeTracking \/ EmploymentQualification" ], "summary": "Update a EmploymentQualification", "operationId": "put_put_employment_qualification", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentQualification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EmploymentQualification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentQualification" } } } } } }, "patch": { "tags": [ "TimeTracking \/ EmploymentQualification" ], "summary": "Update a EmploymentQualification", "operationId": "patch_put_employment_qualification", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmploymentQualification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EmploymentQualification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmploymentQualification" } } } } } } }, "\/api\/time\/processed\/employment_contract_month\/{id}": { "get": { "tags": [ "TimeTracking \/ ProcessedEmploymentContractMonth" ], "summary": "Get a single ProcessedEmploymentContractMonth", "operationId": "get_get_processed_employment_contract_month", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single ProcessedEmploymentContractMonth", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProcessedEmploymentContractMonth" } } } } } }, "put": { "tags": [ "TimeTracking \/ ProcessedEmploymentContractMonth" ], "summary": "Update a single ProcessedEmploymentContractMonth", "operationId": "put_put_processed_employment_contract_month", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ProcessedEmploymentContractMonth2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single ProcessedEmploymentContractMonth", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProcessedEmploymentContractMonth" } } } } } }, "patch": { "tags": [ "TimeTracking \/ ProcessedEmploymentContractMonth" ], "summary": "Update a single ProcessedEmploymentContractMonth", "operationId": "patch_put_processed_employment_contract_month", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ProcessedEmploymentContractMonth2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single ProcessedEmploymentContractMonth", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ProcessedEmploymentContractMonth" } } } } } } }, "\/api\/time\/processed\/employment_contract_month": { "get": { "tags": [ "TimeTracking \/ ProcessedEmploymentContractMonth" ], "summary": "Get all ProcessedEmploymentContractMonth", "operationId": "get_get_processed_employment_contract_months", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all ProcessedEmploymentContractMonth", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ProcessedEmploymentContractMonth" } } } } } } } }, "\/api\/time\/trainer_entries\/bulk_confirm": { "post": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Confirm (or unconfirm) all TrainerTimeEntry matching the current filter", "description": "Used by the administration in the billing mode \"confirmation_invoice\" to confirm a whole\nmonth of a trainer at once instead of entry by entry.", "operationId": "post_time_trainer_entry_bulk_confirm", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "confirmed", "in": "query", "description": "true = confirm, false = revoke the confirmation", "required": false, "schema": { "type": "boolean" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/trainer_entries": { "get": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Get all TrainerTimeEntry", "operationId": "get_time_trainer_entry_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all TrainerTimeEntry", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } } }, "post": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Create a single TrainerTimeEntry", "operationId": "post_time_trainer_entry_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrainerTimeEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single TrainerTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } } }, "\/api\/time\/trainer_entries\/{id}": { "get": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Get a single TrainerTimeEntry with the given id", "operationId": "get_time_trainer_entry_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single TrainerTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } }, "put": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Update a single TrainerTimeEntry", "operationId": "put_time_trainer_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrainerTimeEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single TrainerTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } }, "delete": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Delete a single TrainerTimeEntry", "operationId": "delete_time_trainer_entry_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single TrainerTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } }, "patch": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Update a single TrainerTimeEntry", "operationId": "patch_time_trainer_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrainerTimeEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single TrainerTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } } }, "\/api\/time\/own_trainer_entries\/pdf": { "get": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Get a PDF list of the own TrainerTimeEntry matching the current filter", "description": "Part of the billing mode \"export\": the trainer can download the tracked times as a plain\nPDF list. The Uebungsleiterabrechnung with the instructor allowance accounting is a\nseparate document created via OwnTrainerTimeBillingController::postAction.", "operationId": "get_own_time_trainer_entry_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/own_trainer_entries": { "get": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Get all own TrainerTimeEntry", "operationId": "get_own_time_trainer_entry_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all own TrainerTimeEntry", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } } }, "post": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Create own TrainerTimeEntry", "operationId": "post_own_time_trainer_entry_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrainerTimeEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create own TrainerTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } } }, "\/api\/time\/own_trainer_entries\/{id}": { "get": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Get own TrainerTimeEntry with the given id", "operationId": "get_own_time_trainer_entry_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get own TrainerTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } }, "put": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Update own TrainerTimeEntry", "operationId": "put_own_time_trainer_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrainerTimeEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update own TrainerTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } }, "delete": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Delete a single own TrainerTimeEntry", "operationId": "delete_own_time_trainer_entry_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single own TrainerTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } }, "patch": { "tags": [ "TimeTracking \/ TrainerTimeEntry" ], "summary": "Update own TrainerTimeEntry", "operationId": "patch_own_time_trainer_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrainerTimeEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update own TrainerTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeEntry" } } } } } } }, "\/api\/time\/trainer_time_billings": { "get": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Get all TrainerTimeBilling", "operationId": "get_time_trainer_billing_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Create a TrainerTimeBilling: collects confirmed entries for a person\/month\/year", "operationId": "post_time_trainer_billing_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Create a TrainerTimeBilling", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeBilling" } } } } } } }, "\/api\/time\/trainer_time_billings\/preview": { "get": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Preview what a TrainerTimeBilling for a person and month would contain", "description": "Dry run of the settlement: reports the billable entries with the contract pricing, the\nresulting totals, the effective billing mode and the instructor allowance accounting without\nwriting anything. Used by the administration before the settlement is actually created.", "operationId": "get_time_trainer_billing_preview", "parameters": [ { "name": "person", "in": "query", "description": "Id of the trainer person", "required": true, "schema": { "type": "integer" } }, { "name": "month", "in": "query", "description": "Month of the settlement", "required": true, "schema": { "type": "integer" } }, { "name": "year", "in": "query", "description": "Year of the settlement", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/trainer_time_billings\/{id}": { "get": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Get a single TrainerTimeBilling", "operationId": "get_time_trainer_billing_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Delete a TrainerTimeBilling", "operationId": "delete_time_trainer_billing_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/trainer_time_billings\/{id}\/incoming_invoice": { "post": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Generate an Eingangsrechnung (incoming invoice) in the name of the trainer for a billing", "operationId": "post_time_trainer_billing_incoming_invoice", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Generate the Eingangsrechnung for a TrainerTimeBilling", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeBilling" } } } } } } }, "\/api\/time\/trainer_time_billings\/{id}\/pdf": { "get": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Generate PDF for a TrainerTimeBilling", "operationId": "get_time_trainer_billing_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/own_trainer_time_billings": { "get": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Get all own TrainerTimeBilling", "operationId": "get_own_time_trainer_billing_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Create an own TrainerTimeBilling (Uebungsleiterabrechnung) for a month", "description": "Only available in the billing mode \"export\" and only when the setting\ntrainer_time_allow_own_billing_document is enabled. All confirmed and not yet billed\nentries of the logged in trainer within the given month are collected.", "operationId": "post_own_time_trainer_billing_post", "parameters": [ { "name": "month", "in": "query", "description": "Month of the settlement", "required": true, "schema": { "type": "integer" } }, { "name": "year", "in": "query", "description": "Year of the settlement", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Create the own trainer settlement for a month", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerTimeBilling" } } } } } } }, "\/api\/time\/own_trainer_time_billings\/{id}": { "get": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Get own TrainerTimeBilling", "operationId": "get_own_time_trainer_billing_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/own_trainer_time_billings\/{id}\/pdf": { "get": { "tags": [ "TimeTracking \/ TrainerTimeBilling" ], "summary": "Generate PDF for own TrainerTimeBilling", "operationId": "get_own_time_trainer_billing_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/volunteer_hour_entry": { "get": { "tags": [ "TimeTracking \/ VolunteerHourEntry" ], "summary": "List volunteer hour entries", "operationId": "get_time_volunteer_hour_entry_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "workDate", "in": "query", "description": "Day the work was done. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "settlement", "in": "query", "description": "The settlement that consumed this entry. A settled entry can no longer be changed. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of VolunteerHourEntry objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/VolunteerHourEntry" } } } } } } }, "post": { "tags": [ "TimeTracking \/ VolunteerHourEntry" ], "summary": "Record volunteer hours for a member. Entries of the administration are approved at once.", "operationId": "post_time_volunteer_hour_entry_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerHourEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new VolunteerHourEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourEntry" } } } } } } }, "\/api\/time\/volunteer_hour_entry\/{id}": { "get": { "tags": [ "TimeTracking \/ VolunteerHourEntry" ], "summary": "Get a single volunteer hour entry", "operationId": "get_time_volunteer_hour_entry_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single VolunteerHourEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourEntry" } } } } } }, "put": { "tags": [ "TimeTracking \/ VolunteerHourEntry" ], "summary": "Update a volunteer hour entry that is not settled yet", "operationId": "put_time_volunteer_hour_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerHourEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VolunteerHourEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourEntry" } } } } } }, "delete": { "tags": [ "TimeTracking \/ VolunteerHourEntry" ], "summary": "Delete a volunteer hour entry that is not settled yet", "operationId": "delete_time_volunteer_hour_entry_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "TimeTracking \/ VolunteerHourEntry" ], "summary": "Update a volunteer hour entry that is not settled yet", "operationId": "patch_time_volunteer_hour_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerHourEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VolunteerHourEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourEntry" } } } } } } }, "\/api\/time\/volunteer_hour_entry\/{id}\/approve": { "post": { "tags": [ "TimeTracking \/ VolunteerHourEntry" ], "summary": "Approve a volunteer hour entry - only approved entries count towards the required hours", "operationId": "post_time_volunteer_hour_entry_approve", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Approve a VolunteerHourEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourEntry" } } } } } } }, "\/api\/time\/volunteer_hour_entry\/{id}\/reject": { "post": { "tags": [ "TimeTracking \/ VolunteerHourEntry" ], "summary": "Reject a volunteer hour entry, optionally with a reason (`reason`) shown to the member", "operationId": "post_time_volunteer_hour_entry_reject", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reject a VolunteerHourEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourEntry" } } } } } } }, "\/api\/time\/volunteer_shift": { "get": { "tags": [ "TimeTracking \/ VolunteerShift" ], "summary": "List helper shifts", "operationId": "get_time_volunteer_shift_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "end", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of VolunteerShift objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/VolunteerShift" } } } } } } }, "post": { "tags": [ "TimeTracking \/ VolunteerShift" ], "summary": "Add a helper shift", "operationId": "post_time_volunteer_shift_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerShift2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new VolunteerShift", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerShift" } } } } } } }, "\/api\/time\/volunteer_shift\/{id}": { "get": { "tags": [ "TimeTracking \/ VolunteerShift" ], "summary": "Get a single helper shift", "operationId": "get_time_volunteer_shift_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single VolunteerShift", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerShift" } } } } } }, "put": { "tags": [ "TimeTracking \/ VolunteerShift" ], "summary": "Update a helper shift", "operationId": "put_time_volunteer_shift_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerShift2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VolunteerShift", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerShift" } } } } } }, "delete": { "tags": [ "TimeTracking \/ VolunteerShift" ], "summary": "Archive a helper shift. Credits of attended helpers stay.", "operationId": "delete_time_volunteer_shift_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "TimeTracking \/ VolunteerShift" ], "summary": "Update a helper shift", "operationId": "patch_time_volunteer_shift_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerShift2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VolunteerShift", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerShift" } } } } } } }, "\/api\/time\/volunteer_shift_assignment": { "get": { "tags": [ "TimeTracking \/ VolunteerShiftAssignment" ], "summary": "List the helpers of shifts (filter `shift`, `person`, `status`)", "operationId": "get_time_volunteer_shift_assignment_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "shift", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of VolunteerShiftAssignment objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/VolunteerShiftAssignment" } } } } } } }, "post": { "tags": [ "TimeTracking \/ VolunteerShiftAssignment" ], "summary": "Add a helper to a shift. The administration may fill a shift beyond its limit.", "operationId": "post_time_volunteer_shift_assignment_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerShiftAssignment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new VolunteerShiftAssignment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerShiftAssignment" } } } } } } }, "\/api\/time\/volunteer_shift_assignment\/{id}": { "get": { "tags": [ "TimeTracking \/ VolunteerShiftAssignment" ], "summary": "Get a single helper assignment", "operationId": "get_time_volunteer_shift_assignment_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single VolunteerShiftAssignment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerShiftAssignment" } } } } } }, "put": { "tags": [ "TimeTracking \/ VolunteerShiftAssignment" ], "summary": "Change the status of a helper: `attended` credits the shift, `no_show` \/ `cancelled`\nremove that credit again", "operationId": "put_time_volunteer_shift_assignment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerShiftAssignment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VolunteerShiftAssignment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerShiftAssignment" } } } } } }, "delete": { "tags": [ "TimeTracking \/ VolunteerShiftAssignment" ], "summary": "Remove a helper from a shift together with an unsettled credit", "operationId": "delete_time_volunteer_shift_assignment_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "TimeTracking \/ VolunteerShiftAssignment" ], "summary": "Change the status of a helper: `attended` credits the shift, `no_show` \/ `cancelled`\nremove that credit again", "operationId": "patch_time_volunteer_shift_assignment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerShiftAssignment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VolunteerShiftAssignment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerShiftAssignment" } } } } } } }, "\/api\/time\/volunteer_hour_requirement": { "get": { "tags": [ "TimeTracking \/ VolunteerHourRequirement" ], "summary": "List individual volunteer hour rules", "operationId": "get_time_volunteer_hour_requirement_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "exempt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "validFrom", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "validUntil", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of VolunteerHourRequirement objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/VolunteerHourRequirement" } } } } } } }, "post": { "tags": [ "TimeTracking \/ VolunteerHourRequirement" ], "summary": "Add an individual volunteer hour rule", "operationId": "post_time_volunteer_hour_requirement_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerHourRequirement2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new VolunteerHourRequirement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourRequirement" } } } } } } }, "\/api\/time\/volunteer_hour_requirement\/{id}": { "get": { "tags": [ "TimeTracking \/ VolunteerHourRequirement" ], "summary": "Get a single individual volunteer hour rule", "operationId": "get_time_volunteer_hour_requirement_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single VolunteerHourRequirement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourRequirement" } } } } } }, "put": { "tags": [ "TimeTracking \/ VolunteerHourRequirement" ], "summary": "Update an individual volunteer hour rule", "operationId": "put_time_volunteer_hour_requirement_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerHourRequirement2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VolunteerHourRequirement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourRequirement" } } } } } }, "delete": { "tags": [ "TimeTracking \/ VolunteerHourRequirement" ], "summary": "Delete an individual volunteer hour rule", "operationId": "delete_time_volunteer_hour_requirement_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "TimeTracking \/ VolunteerHourRequirement" ], "summary": "Update an individual volunteer hour rule", "operationId": "patch_time_volunteer_hour_requirement_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerHourRequirement2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a VolunteerHourRequirement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourRequirement" } } } } } } }, "\/api\/time\/volunteer_hour_settlement": { "get": { "tags": [ "TimeTracking \/ VolunteerHourSettlement" ], "summary": "List volunteer hour settlements", "operationId": "get_time_volunteer_hour_settlement_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "person", "in": "query", "description": "Set when the hours are owed per member. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Billing account the compensation is charged to. When the hours are owed per account (household), the settlement belongs to the account only and person stays empty. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "periodStart", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "periodEnd", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "generationDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of VolunteerHourSettlement objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/VolunteerHourSettlement" } } } } } } } }, "\/api\/time\/volunteer_hour_settlement\/preview": { "get": { "tags": [ "TimeTracking \/ VolunteerHourSettlement" ], "summary": "Preview the settlement of the period containing `date` (default today) without writing\nanything: who owes how many hours, what has been credited, the compensation per member.", "description": "`person` \/ `company` restrict it to one member or billing account.", "operationId": "get_time_volunteer_hour_settlement_preview", "parameters": [ { "name": "date", "in": "query", "description": "A date inside the period", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Id of a member", "required": false, "schema": { "type": "integer" } }, { "name": "company", "in": "query", "description": "Id of a billing account", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/volunteer_hour_settlement\/generate": { "post": { "tags": [ "TimeTracking \/ VolunteerHourSettlement" ], "summary": "Create the settlements of the period containing `date`. Already settled members and\nmembers without obligation are skipped. `createInvoices` (default: true in the INVOICE\nmode) invoices the compensation to the billing accounts right away.", "operationId": "post_time_volunteer_hour_settlement_generate", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/volunteer_hour_settlement\/{id}": { "get": { "tags": [ "TimeTracking \/ VolunteerHourSettlement" ], "summary": "Get a single volunteer hour settlement", "operationId": "get_time_volunteer_hour_settlement_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single VolunteerHourSettlement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourSettlement" } } } } } }, "delete": { "tags": [ "TimeTracking \/ VolunteerHourSettlement" ], "summary": "Delete a settlement that has no invoice. Its entries become editable again.", "operationId": "delete_time_volunteer_hour_settlement_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/volunteer_hour_settlement\/{id}\/invoice": { "post": { "tags": [ "TimeTracking \/ VolunteerHourSettlement" ], "summary": "Invoice the compensation of a settlement to its billing account", "operationId": "post_time_volunteer_hour_settlement_invoice", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invoice the compensation of a VolunteerHourSettlement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourSettlement" } } } } } } }, "\/api\/time\/volunteer_hour_settlement\/{id}\/waive": { "post": { "tags": [ "TimeTracking \/ VolunteerHourSettlement" ], "summary": "Waive the compensation of a settlement (Erlass), with an optional `note`", "operationId": "post_time_volunteer_hour_settlement_waive", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Waive the compensation of a VolunteerHourSettlement", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/VolunteerHourSettlement" } } } } } } }, "\/api\/time\/own_volunteer_hours\/summary": { "get": { "tags": [ "TimeTracking \/ Own volunteer hours" ], "summary": "Volunteer hours of the logged in member in the period containing `date` (default today):\nrequired, credited, pending, missing hours and the expected compensation", "operationId": "get_own_time_volunteer_hours_summary", "parameters": [ { "name": "date", "in": "query", "description": "A date inside the period", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/own_volunteer_hour_entry": { "get": { "tags": [ "TimeTracking \/ Own volunteer hours" ], "summary": "Own volunteer hour entries, newest first", "operationId": "get_own_time_volunteer_hour_entry_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "TimeTracking \/ Own volunteer hours" ], "summary": "Record own volunteer hours. They count once the administration approved them, unless the\ninstallation approves them automatically.", "operationId": "post_own_time_volunteer_hour_entry_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/VolunteerHourEntry2" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/time\/own_volunteer_hour_entry\/{id}": { "delete": { "tags": [ "TimeTracking \/ Own volunteer hours" ], "summary": "Delete an own entry that has not been approved or settled", "operationId": "delete_own_time_volunteer_hour_entry_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/own_volunteer_shift": { "get": { "tags": [ "TimeTracking \/ Own volunteer hours" ], "summary": "Upcoming helper shifts with free slots and the own sign-up status", "operationId": "get_own_time_volunteer_shift_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/own_volunteer_shift\/{id}\/sign_up": { "post": { "tags": [ "TimeTracking \/ Own volunteer hours" ], "summary": "Sign up for a helper shift", "operationId": "post_own_time_volunteer_shift_sign_up", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/own_volunteer_shift\/{id}\/cancel": { "post": { "tags": [ "TimeTracking \/ Own volunteer hours" ], "summary": "Cancel the own sign-up for a helper shift (until the configured deadline before the start)", "operationId": "post_own_time_volunteer_shift_cancel", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/trainer_contracts": { "get": { "tags": [ "TimeTracking \/ TrainerContract" ], "summary": "Get all TrainerContracts", "operationId": "get_time_trainer_contract_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "TimeTracking \/ TrainerContract" ], "summary": "Create a TrainerContract", "operationId": "post_time_trainer_contract_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/trainer_contracts\/{id}": { "get": { "tags": [ "TimeTracking \/ TrainerContract" ], "summary": "Get a single TrainerContract", "operationId": "get_time_trainer_contract_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "TimeTracking \/ TrainerContract" ], "summary": "Update a TrainerContract", "operationId": "put_time_trainer_contract_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "TimeTracking \/ TrainerContract" ], "summary": "Delete a TrainerContract", "operationId": "delete_time_trainer_contract_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "TimeTracking \/ TrainerContract" ], "summary": "Update a TrainerContract", "operationId": "patch_time_trainer_contract_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/time\/trainer\/qualification": { "get": { "tags": [ "TimeTracking \/ TrainerQualification" ], "summary": "This method will get all TrainerQualification Objects", "operationId": "get_time_trainer_qualification_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of TrainerQualification objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TrainerQualification" } } } } } } }, "post": { "tags": [ "TimeTracking \/ TrainerQualification" ], "summary": "Add a new TrainerQualification", "operationId": "post_time_trainer_qualification_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrainerQualification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new TrainerQualification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerQualification" } } } } } } }, "\/api\/time\/trainer\/qualification\/{id}": { "get": { "tags": [ "TimeTracking \/ TrainerQualification" ], "summary": "This method will get a single TrainerQualification with the given id", "operationId": "get_time_trainer_qualification_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single TrainerQualification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerQualification" } } } } } }, "put": { "tags": [ "TimeTracking \/ TrainerQualification" ], "summary": "Update a TrainerQualification", "operationId": "put_time_trainer_qualification_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrainerQualification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a TrainerQualification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerQualification" } } } } } }, "patch": { "tags": [ "TimeTracking \/ TrainerQualification" ], "summary": "Update a TrainerQualification", "operationId": "patch_time_trainer_qualification_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrainerQualification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a TrainerQualification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrainerQualification" } } } } } } }, "\/api\/time\/workentries": { "get": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Get all WorkTimeEntry", "operationId": "get_time_work_entry_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all WorkTimeEntry", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorkTimeEntry" } } } } } } }, "post": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Create a single WorkTimeEntry", "operationId": "post_time_work_entry_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "work_time_entry": { "$ref": "#\/components\/schemas\/WorkTimeEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single WorkTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntry" } } } } } } }, "\/api\/time\/workentries\/{id}": { "get": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Get a single WorkTimeEntry", "operationId": "get_time_work_entry_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single WorkTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntry" } } } } } }, "put": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Update a single WorkTimeEntry", "operationId": "put_time_work_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "work_time_entry": { "$ref": "#\/components\/schemas\/WorkTimeEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single WorkTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntry" } } } } } }, "delete": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Delete a single WorkTimeEntry", "operationId": "delete_time_work_entry_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single WorkTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntry" } } } } } }, "patch": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Update a single WorkTimeEntry", "operationId": "patch_time_work_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "work_time_entry": { "$ref": "#\/components\/schemas\/WorkTimeEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single WorkTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntry" } } } } } } }, "\/api\/time\/current_own_workentry": { "get": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Get the current own WorkTimeEntry", "operationId": "get_time_work_entry_current_own_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get the current own WorkTimeEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WorkTimeEntry" } } } } } } }, "\/api\/time\/work_entry_grouped\/months": { "get": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Get WorkTimeEntries grouped by month for user or person", "operationId": "get_time_work_entry_grouped_months", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get WorkTimeEntries grouped by month for user or person", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorkTimeEntryGroupedMonth" } } } } } } } }, "\/api\/time\/work_entry_grouped\/own_months": { "get": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Get own WorkTimeEntries grouped by month", "operationId": "get_time_work_entry_grouped_own_months", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get own WorkTimeEntries grouped by month", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorkTimeEntryGroupedMonth" } } } } } } } }, "\/api\/time\/work_entry_grouped\/dates": { "get": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Get WorkTimeEntries grouped by date for user or person", "operationId": "get_time_work_entry_grouped_dates", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get WorkTimeEntries grouped by date for user or person", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorkTimeEntryGroupedDate" } } } } } } } }, "\/api\/time\/work_entry_grouped\/own_dates": { "get": { "tags": [ "TimeTracking \/ WorkTimeEntry" ], "summary": "Get own WorkTimeEntries grouped by date", "operationId": "get_time_work_entry_grouped_own_dates", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get own WorkTimeEntries grouped by date", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorkTimeEntryGroupedDate" } } } } } } } }, "\/api\/time\/non_work_time_request": { "get": { "tags": [ "TimeTracking \/ NonWorkTimeRequest" ], "summary": "Get all NonWorkTimeRequest", "operationId": "get_time_non_work_time_request_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all NonWorkTimeRequest", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest" } } } } } } }, "post": { "tags": [ "TimeTracking \/ NonWorkTimeRequest" ], "summary": "Create a single NonWorkTimeRequest", "operationId": "post_time_non_work_time_request_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single NonWorkTimeRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest3" } } } } } } }, "\/api\/time\/non_work_time_request\/{id}": { "get": { "tags": [ "TimeTracking \/ NonWorkTimeRequest" ], "summary": "Get a single NonWorkTimeRequest", "operationId": "get_time_non_work_time_request_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single NonWorkTimeRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest3" } } } } } }, "put": { "tags": [ "TimeTracking \/ NonWorkTimeRequest" ], "summary": "Update a single NonWorkTimeRequest", "operationId": "put_time_non_work_time_request_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "action", "in": "query", "description": "CANCEL_OWN withdraws an own pending request without binding body fields", "required": false, "schema": { "type": "string", "enum": [ "CANCEL_OWN" ] } }, { "name": "approval_version", "in": "query", "description": "Displayed request version; required for CANCEL_OWN and staged decisions", "required": false, "schema": { "type": "integer" } }, { "name": "approval_comment", "in": "query", "description": "Written decision of the current approval step; mandatory for the management (Gesch\u00e4ftsleitung) step", "required": false, "schema": { "type": "string" } }, { "name": "balance_override_reason", "in": "query", "description": "L11: reason for approving although the projected year-end vacation balance is negative; required when non_work_time_negative_balance_override_required is on", "required": false, "schema": { "type": "string" } }, { "name": "coverage_override_reason", "in": "query", "description": "L54: reason for approving although a day drops below the minimum staffing; required when staffing_coverage_override_reason_required is on", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single NonWorkTimeRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ NonWorkTimeRequest" ], "summary": "Update a single NonWorkTimeRequest", "operationId": "patch_time_non_work_time_request_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "action", "in": "query", "description": "CANCEL_OWN withdraws an own pending request without binding body fields", "required": false, "schema": { "type": "string", "enum": [ "CANCEL_OWN" ] } }, { "name": "approval_version", "in": "query", "description": "Displayed request version; required for CANCEL_OWN and staged decisions", "required": false, "schema": { "type": "integer" } }, { "name": "approval_comment", "in": "query", "description": "Written decision of the current approval step; mandatory for the management (Gesch\u00e4ftsleitung) step", "required": false, "schema": { "type": "string" } }, { "name": "balance_override_reason", "in": "query", "description": "L11: reason for approving although the projected year-end vacation balance is negative; required when non_work_time_negative_balance_override_required is on", "required": false, "schema": { "type": "string" } }, { "name": "coverage_override_reason", "in": "query", "description": "L54: reason for approving although a day drops below the minimum staffing; required when staffing_coverage_override_reason_required is on", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single NonWorkTimeRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest3" } } } } } } }, "\/api\/time\/non_work_time_request_test": { "post": { "tags": [ "TimeTracking \/ NonWorkTimeRequest" ], "summary": "Test a single NonWorkTimeRequest", "operationId": "post_time_non_work_time_request_post_test", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Test a single NonWorkTimeRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest3" } } } } } } }, "\/api\/time\/non_work_time_annual_request": { "get": { "tags": [ "TimeTracking \/ NonWorkTimeAnnualRequest" ], "summary": "List annual requests", "operationId": "get_time_non_work_time_annual_request_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contract", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "year", "in": "query", "description": "The vacation year the periods belong to. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Absence type of every period (NonWorkTimePlanSelectionType value). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Derived from the periods, see class comment. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "createdByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List NonWorkTimeAnnualRequest objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest" } } } } } } }, "post": { "tags": [ "TimeTracking \/ NonWorkTimeRequest" ], "summary": "Create an annual request (\"Jahresurlaubsantrag\") with several separate periods (L47\/L48)", "description": "Every period becomes an ordinary request of the bundle and runs through the same rules\nas a single request; one failing period refuses the whole bundle.", "operationId": "post_time_non_work_time_annual_request_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create an annual request with several periods", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest3" } } } } } } }, "\/api\/time\/non_work_time_annual_request\/{id}": { "get": { "tags": [ "TimeTracking \/ NonWorkTimeAnnualRequest" ], "summary": "Get a single annual request with its periods", "operationId": "get_time_non_work_time_annual_request_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single NonWorkTimeAnnualRequest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest3" } } } } } } }, "\/api\/time\/non_work_time_annual_request\/{id}\/decide": { "put": { "tags": [ "TimeTracking \/ NonWorkTimeRequest" ], "summary": "Decide an annual request as a whole (L48): every open period the current session may\ndecide gets the same decision; `declined_requests` lists period ids to refuse while the\nrest is approved.", "operationId": "put_time_non_work_time_annual_request_put_decide", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "decision", "in": "query", "description": "APPROVED or DECLINED", "required": true, "schema": { "type": "string", "enum": [ "APPROVED", "DECLINED" ] } }, { "name": "approval_comment", "in": "query", "description": "Written decision, mandatory for the management step", "required": false, "schema": { "type": "string" } }, { "name": "declined_requests", "in": "query", "description": "Comma separated ids of periods to refuse while approving the rest", "required": false, "schema": { "type": "string" } }, { "name": "balance_override_reason", "in": "query", "description": "L11 override reason", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Decide all open periods of an annual request", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest3" } } } } } }, "patch": { "tags": [ "TimeTracking \/ NonWorkTimeRequest" ], "summary": "Decide an annual request as a whole (L48): every open period the current session may\ndecide gets the same decision; `declined_requests` lists period ids to refuse while the\nrest is approved.", "operationId": "patch_time_non_work_time_annual_request_put_decide", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "decision", "in": "query", "description": "APPROVED or DECLINED", "required": true, "schema": { "type": "string", "enum": [ "APPROVED", "DECLINED" ] } }, { "name": "approval_comment", "in": "query", "description": "Written decision, mandatory for the management step", "required": false, "schema": { "type": "string" } }, { "name": "declined_requests", "in": "query", "description": "Comma separated ids of periods to refuse while approving the rest", "required": false, "schema": { "type": "string" } }, { "name": "balance_override_reason", "in": "query", "description": "L11 override reason", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Decide all open periods of an annual request", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest3" } } } } } } }, "\/api\/time\/non_work_time_request_comment": { "get": { "tags": [ "TimeTracking \/ NonWorkTimeRequestComment" ], "summary": "Get all NonWorkTimeRequestComment", "operationId": "get_time_non_work_time_request_comment_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all NonWorkTimeRequestComment", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment" } } } } } } } }, "\/api\/time\/non_work_time_request_comment\/for_parent\/{parentIdentifier}": { "get": { "tags": [ "TimeTracking \/ NonWorkTimeRequestComment" ], "summary": "Get all NonWorkTimeRequestComment for a single NonWorkTimeRequest", "operationId": "get_time_non_work_time_request_comment_cget_parent", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "parentIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get all NonWorkTimeRequestComment for a single NonWorkTimeRequest", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment" } } } } } } } }, "\/api\/time\/non_work_time_request_comment\/{id}": { "get": { "tags": [ "TimeTracking \/ NonWorkTimeRequestComment" ], "summary": "Get a single NonWorkTimeRequestComment", "operationId": "get_time_non_work_time_request_comment_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single NonWorkTimeRequestComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment" } } } } } }, "put": { "tags": [ "TimeTracking \/ NonWorkTimeRequestComment" ], "summary": "Update a single NonWorkTimeRequestComment", "operationId": "put_time_non_work_time_request_comment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single NonWorkTimeRequestComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment" } } } } } }, "patch": { "tags": [ "TimeTracking \/ NonWorkTimeRequestComment" ], "summary": "Update a single NonWorkTimeRequestComment", "operationId": "patch_time_non_work_time_request_comment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single NonWorkTimeRequestComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment" } } } } } } }, "\/api\/time\/non_work_time_request_comment\/{parentIdentifier}": { "post": { "tags": [ "TimeTracking \/ NonWorkTimeRequestComment" ], "summary": "Create a single NonWorkTimeRequestComment", "operationId": "post_time_non_work_time_request_comment_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "parentIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single NonWorkTimeRequestComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment" } } } } } } }, "\/api\/employee_documents\/document": { "get": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Get all EmployeeDocument", "operationId": "get_employee_document_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "token", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requiresAcknowledgment", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "requiresSignature", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "requiresFormFilling", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "targetAllEmployees", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "dueDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publishedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "createdByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "createdByPerson", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all EmployeeDocument", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocument" } } } } } } }, "post": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Create a single EmployeeDocument (draft)", "operationId": "post_employee_document_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmployeeDocument2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single EmployeeDocument", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocument3" } } } } } } }, "\/api\/employee_documents\/acknowledgment": { "get": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "List the acknowledgments and signatures of one person, across all documents.", "description": "Deliberately scoped to a person: this is the personnel file question, and an\nunbounded list of who signed what is not something to hand out by accident. The\nperson is required, and reading somebody else's needs HR access or leadership.", "operationId": "get_employee_document_acknowledgment_cget_person", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "document", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contract", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Acknowledgments and signatures of one person", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocumentAcknowledgment" } } } } } } } }, "\/api\/employee_documents\/document\/{id}": { "get": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Get a single EmployeeDocument", "operationId": "get_employee_document_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single EmployeeDocument", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocument3" } } } } } }, "put": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Update a single EmployeeDocument", "operationId": "put_employee_document_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmployeeDocument2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single EmployeeDocument", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocument3" } } } } } }, "delete": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Delete a single EmployeeDocument", "operationId": "delete_employee_document_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single EmployeeDocument, only allowed while it is still a draft", "content": { "application\/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } } } }, "\/api\/employee_documents\/document\/{id}\/publish": { "post": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Publish an EmployeeDocument", "operationId": "post_employee_document_post_publish", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Publish an EmployeeDocument", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocument3" } } } } } } }, "\/api\/employee_documents\/document\/{id}\/archive": { "post": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Archive an EmployeeDocument", "operationId": "post_employee_document_post_archive", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Archive an EmployeeDocument", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocument3" } } } } } } }, "\/api\/employee_documents\/document\/{id}\/upload": { "post": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Attach an already uploaded file to an EmployeeDocument. The file itself goes through\nthe Attachment endpoints first, this takes its download link and links it up.", "operationId": "post_employee_document_post_upload", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "simpleid": { "properties": { "id": { "description": "download link of the already uploaded Attachment", "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Attach a file to an EmployeeDocument", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocument3" } } } } } } }, "\/api\/employee_documents\/document\/{id}\/acknowledge": { "post": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Acknowledge an EmployeeDocument", "operationId": "post_employee_document_post_acknowledge", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Acknowledge an EmployeeDocument", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocumentAcknowledgment2" } } } } } } }, "\/api\/employee_documents\/document\/{id}\/sign": { "post": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Sign an EmployeeDocument", "operationId": "post_employee_document_post_sign", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "signatureData is read from the data envelope, or from the request body directly", "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "signatureData": { "description": "the drawn signature as a base64 encoded image", "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Sign an EmployeeDocument", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocumentAcknowledgment2" } } } } } } }, "\/api\/employee_documents\/document\/{id}\/acknowledgments": { "get": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Get acknowledgments for an EmployeeDocument", "operationId": "get_employee_document_get_acknowledgments", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "document", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contract", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get acknowledgments for a document", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocumentAcknowledgment2" } } } } } } } }, "\/api\/employee_documents\/document\/{id}\/status": { "get": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Get status summary for an EmployeeDocument (who acknowledged, who hasn't)", "operationId": "get_employee_document_get_status", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Who was targeted by the document and who has already acknowledged, signed or responded", "content": { "application\/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "properties": { "totalTargeted": { "type": "integer" }, "totalAcknowledged": { "type": "integer" }, "totalPendingAcknowledgment": { "type": "integer" }, "totalResponses": { "type": "integer" }, "totalPendingResponse": { "type": "integer" }, "acknowledgments": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocumentAcknowledgment" } } }, "type": "object" } }, "type": "object" } } } } } } }, "\/api\/employee_documents\/dashboard": { "get": { "tags": [ "TimeTracking \/ EmployeeDocument" ], "summary": "Get dashboard summary for current user", "operationId": "get_employee_document_get_dashboard", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "What the logged in user still has to do: documents waiting for an acknowledgment, a signature or a filled in form", "content": { "application\/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "properties": { "pendingAcknowledgment": { "type": "integer" }, "pendingSignature": { "type": "integer" }, "pendingFormFilling": { "type": "integer" }, "pendingAcknowledgmentDocuments": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocument" } }, "pendingSignatureDocuments": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocument" } }, "pendingFormFillingDocuments": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocument" } } }, "type": "object" } }, "type": "object" } } } } } } }, "\/api\/employee_documents\/comment\/for_parent\/{parentIdentifier}": { "get": { "tags": [ "TimeTracking \/ EmployeeDocumentComment" ], "summary": "Get all EmployeeDocumentComment for a single EmployeeDocument", "operationId": "get_employee_document_comment_cget_parent", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "document", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "parentIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get all EmployeeDocumentComment for a single EmployeeDocument", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocumentComment" } } } } } } } }, "\/api\/employee_documents\/comment\/{id}": { "get": { "tags": [ "TimeTracking \/ EmployeeDocumentComment" ], "summary": "Get a single EmployeeDocumentComment", "operationId": "get_employee_document_comment_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single EmployeeDocumentComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocumentComment" } } } } } }, "put": { "tags": [ "TimeTracking \/ EmployeeDocumentComment" ], "summary": "Update a single EmployeeDocumentComment", "operationId": "put_employee_document_comment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmployeeDocumentComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single EmployeeDocumentComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocumentComment" } } } } } }, "patch": { "tags": [ "TimeTracking \/ EmployeeDocumentComment" ], "summary": "Update a single EmployeeDocumentComment", "operationId": "patch_employee_document_comment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmployeeDocumentComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single EmployeeDocumentComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocumentComment" } } } } } } }, "\/api\/employee_documents\/comment\/{parentIdentifier}": { "post": { "tags": [ "TimeTracking \/ EmployeeDocumentComment" ], "summary": "Create a single EmployeeDocumentComment", "operationId": "post_employee_document_comment_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "parentIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmployeeDocumentComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single EmployeeDocumentComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocumentComment" } } } } } } }, "\/api\/employee_documents\/response": { "get": { "tags": [ "TimeTracking \/ EmployeeDocumentResponse" ], "summary": "List the responses of one person, across all documents.", "description": "Scoped to a person on purpose - a filled in form is personnel data, and an unbounded\nlist of them is not something to hand out by accident. The person is required, and\nreading somebody else's needs HR access or leadership.", "operationId": "get_employee_document_response_cget_person", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "document", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reviewedByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reviewedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Responses of one person", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocumentResponse" } } } } } } } }, "\/api\/employee_documents\/response\/for_parent\/{parentIdentifier}": { "get": { "tags": [ "TimeTracking \/ EmployeeDocumentResponse" ], "summary": "Get all EmployeeDocumentResponse for a single EmployeeDocument", "operationId": "get_employee_document_response_cget_parent", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "document", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reviewedByUser", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reviewedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "parentIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get all EmployeeDocumentResponse for a single EmployeeDocument", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocumentResponse2" } } } } } } } }, "\/api\/employee_documents\/response\/{parentIdentifier}": { "post": { "tags": [ "TimeTracking \/ EmployeeDocumentResponse" ], "summary": "Submit a response (filled form re-upload) for an EmployeeDocument", "operationId": "post_employee_document_response_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "parentIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Submit a response for an EmployeeDocument", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocumentResponse2" } } } } } } }, "\/api\/employee_documents\/response\/{id}": { "put": { "tags": [ "TimeTracking \/ EmployeeDocumentResponse" ], "summary": "Review a response (accept or reject)", "operationId": "put_employee_document_response_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EmployeeDocumentResponse2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Review a response", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EmployeeDocumentResponse2" } } } } } } }, "\/api\/servermanagement\/shortlink": { "get": { "tags": [ "ServerManagement \/ ShortLink" ], "summary": "Returns a list of ShortLink", "operationId": "get_cget_shortlink", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shortText", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "longText", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "utmId", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "utmSource", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "utmMedium", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "utmCampaign", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "utmTerm", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "utmContent", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "trackingProvider", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "archived", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "clicksToday", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "clicksWeek", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "clicksYear", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "searchString", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of ShortLink", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ShortLink" } } } } } } }, "post": { "tags": [ "ServerManagement \/ ShortLink" ], "summary": "Create a single ShortLink", "operationId": "post_post_shortlink", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShortLink2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a single ShortLink", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShortLink3" } } } } } } }, "\/api\/servermanagement\/shortlink\/{id}": { "get": { "tags": [ "ServerManagement \/ ShortLink" ], "summary": "Returns a single ShortLink with the given id", "operationId": "get_get_shortlink", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single ShortLink with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShortLink3" } } } } } }, "put": { "tags": [ "ServerManagement \/ ShortLink" ], "summary": "Update a single ShortLink", "operationId": "put_put_shortlink", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShortLink2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single ShortLink", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShortLink3" } } } } } }, "delete": { "tags": [ "ServerManagement \/ ShortLink" ], "summary": "Deletes a single ShortLink", "operationId": "delete_delete_shortlink", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single ShortLink", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShortLink3" } } } } } }, "patch": { "tags": [ "ServerManagement \/ ShortLink" ], "summary": "Update a single ShortLink", "operationId": "patch_put_shortlink", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ShortLink2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single ShortLink", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ShortLink3" } } } } } } }, "\/api\/servermanagement\/iwmon\/alert": { "post": { "tags": [ "Server Management \/ iwmon" ], "summary": "Returns an alert.", "operationId": "post_inwendo_iwmon_webhook_alert", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Alert accepted; notified = number of notifications created" }, "400": { "description": "Invalid payload" }, "401": { "description": "Missing, expired or invalid signature" }, "404": { "description": "Webhook switched off" } } } }, "\/api\/servermanagement\/iwmon\/widget": { "get": { "tags": [ "Server Management \/ iwmon" ], "summary": "Current state of the server monitoring: status ok \/ warning \/ critical \/ unknown, host\ncounts and the most important firing alerts.", "operationId": "get_inwendo_iwmon_widget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Monitoring state for the widget" } } } }, "\/api\/app_widget\/available": { "get": { "tags": [ "Settings \/ AppWidget" ], "summary": "Native widgets the current user may use, filtered by rights and configuration. Without a valid\nsession the list is empty (no 401, so the apps can simply remove all widgets). Optional filter: app.", "operationId": "get_inwendo_app_widget_available", "parameters": [ { "name": "app", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "main_erp" ] } } ], "responses": { "200": { "description": "{version, widgets: [{id, title, description, translations, apps, data_endpoint, refresh_seconds, sizes}]}" } } } }, "\/api\/app_widget\/token": { "post": { "tags": [ "Settings \/ AppWidget" ], "summary": "Creates the API access token for one placed widget on one device and revokes the previous one of\nthat widget and device. The token may only GET the widget's data endpoint, with the widget's\nscope; send it as x-iw-jwt-token header. It is returned only here.", "description": "Needs a normal login session (not an API token) and the rights the widget requires.", "operationId": "post_inwendo_app_widget_token_create", "parameters": [ { "name": "widget", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "device_id", "in": "query", "description": "random id of the app installation, 8-64 chars [A-Za-z0-9-]", "required": true, "schema": { "type": "string" } }, { "name": "device_name", "in": "query", "description": "shown in the API token list", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{widget, token, header, data_endpoint, expires}" } } }, "delete": { "tags": [ "Settings \/ AppWidget" ], "summary": "Revokes the widget tokens of this device: of one widget, or of all widgets when widget is\nempty (e.g. on logout). Needs a normal login session.", "operationId": "delete_inwendo_app_widget_token_delete", "parameters": [ { "name": "widget", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "device_id", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{revoked: number of revoked tokens}" } } } }, "\/api\/softwaremanagement\/appcasts\/{id}.xml": { "get": { "tags": [ "SoftwareManagement \/ Appcast" ], "summary": "Sparkle appcast (RSS) with the newest signed builds of a software. Query parameter\nchannel selects the branch, default release.", "operationId": "get_get_software_appcast", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } }, "head": { "tags": [ "SoftwareManagement \/ Appcast" ], "summary": "Sparkle appcast (RSS) with the newest signed builds of a software. Query parameter\nchannel selects the branch, default release.", "operationId": "head_get_software_appcast", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/attendancelist": { "get": { "tags": [ "Event \/ AttendanceList" ], "summary": "This method will get all AttendanceList Objects", "operationId": "get_cget_attendancelist", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of AttendanceList objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AttendanceList" } } } } } } }, "post": { "tags": [ "Event \/ AttendanceList" ], "summary": "Add a new AttendanceList", "operationId": "post_post_attendancelist", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new AttendanceList", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceList" } } } } } } }, "\/api\/event\/attendancelist\/{id}": { "put": { "tags": [ "Event \/ AttendanceList" ], "summary": "Update a AttendanceList", "operationId": "put_put_attendancelist", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a AttendanceList", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceList" } } } } } }, "patch": { "tags": [ "Event \/ AttendanceList" ], "summary": "Update a AttendanceList", "operationId": "patch_put_attendancelist", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a AttendanceList", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceList" } } } } } } }, "\/api\/event\/attendancelist\/{listIdentifier}": { "get": { "tags": [ "Event \/ AttendanceList" ], "summary": "This method will get a single AttendanceList with the given id or token", "operationId": "get_get_attendancelist", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "listIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single AttendanceList with the given id or token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceList" } } } } } } }, "\/api\/event\/attendancelist\/{id}\/add\/viewer": { "post": { "tags": [ "Event \/ AttendanceList" ], "summary": "Add a viewer to a AttendanceList", "operationId": "post_post_attendancelist_add_viewer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add a viewer to a AttendanceList", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceList" } } } } } } }, "\/api\/event\/attendancelist\/{id}\/delete\/viewer": { "post": { "tags": [ "Event \/ AttendanceList" ], "summary": "Delete a viewer from a AttendanceList", "operationId": "post_post_attendancelist_delete_viewer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a viewer from a AttendanceList", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceList" } } } } } } }, "\/api\/event\/attendancelist\/{listIdentifier}\/export": { "get": { "tags": [ "Event \/ AttendanceList" ], "summary": "This method will export a single AttendanceList with the given id or token", "operationId": "get_get_attendancelist_export", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "listIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/attendancelist\/{listIdentifier}\/entries": { "get": { "tags": [ "Event \/ AttendanceList" ], "summary": "This method will get the list entries for the given list", "operationId": "get_get_attendancelist_entries", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "listIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of AttendanceListEntry objects for the given list", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AttendanceListEntry" } } } } } } } }, "\/api\/event\/attendancelist\/{listIdentifier}\/entry": { "post": { "tags": [ "Event \/ AttendanceListEntry" ], "summary": "Add a new AttendanceListEntry", "operationId": "post_post_attendancelist_entry", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "listIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add a new AttendanceListEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceListEntry" } } } } } } }, "\/api\/event\/attendancelist\/{entryIdentifier}\/entry": { "get": { "tags": [ "Event \/ AttendanceListEntry" ], "summary": "This method will get a single AttendanceListEntry with the given id or token", "operationId": "get_get_attendancelist_entry", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "entryIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single AttendanceListEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceListEntry" } } } } } }, "put": { "tags": [ "Event \/ AttendanceListEntry" ], "summary": "Update a AttendanceListEntry", "operationId": "put_put_attendancelist_entry", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "entryIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a AttendanceListEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceListEntry" } } } } } }, "patch": { "tags": [ "Event \/ AttendanceListEntry" ], "summary": "Update a AttendanceListEntry", "operationId": "patch_put_attendancelist_entry", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "entryIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a AttendanceListEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceListEntry" } } } } } } }, "\/api\/event\/moment": { "get": { "tags": [ "Event \/ Moments" ], "summary": "List event moments (filterable by event, type and moderation status).", "operationId": "get_cget_event_moment", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "momentType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "moderationStatus", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "signUp", "in": "query", "description": "Optional participant reference; null for anonymous contributions via the anonymous event moments token. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EventMoment objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventMoment" } } } } } } } }, "\/api\/event\/moment\/{identifier}": { "get": { "tags": [ "Event \/ Moments" ], "summary": "Get a single event moment.", "operationId": "get_get_event_moment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EventMoment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventMoment" } } } } } }, "delete": { "tags": [ "Event \/ Moments" ], "summary": "Delete a moment: soft-deletes the entity and removes the stored file (GDPR deletion concept).", "operationId": "delete_delete_event_moment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/moment\/upload\/{eventIdentifier}": { "post": { "tags": [ "Event \/ Moments" ], "summary": "Add a moment on behalf of the organizer: a voice message, photo, drawing or\nvideo collected outside the guest page (a recording from the party, the\nphotographer's pictures), or a text entry.", "description": "Same form fields as the guest upload (multipart, prefix `event_moment`), minus\nthe consent: the organizer collects the guestbook, so the moment is stored as\nconsented and already approved. The file limits and formats are the guest\nones (`event_moments_max_file_size_mb`, `event_moments_max_video_file_size_mb`,\n`event_moments_allowed_*_mime_types`), the virus scan runs in the background\nas for every upload.", "operationId": "post_post_event_moment_upload", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Creates an EventMoment from an organizer upload", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventMoment" } } } } } } }, "\/api\/event\/moment\/{identifier}\/moderation": { "put": { "tags": [ "Event \/ Moments" ], "summary": "Update the moderation status of a moment (PENDING \/ APPROVED \/ HIDDEN).", "operationId": "put_put_event_moment_moderation", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates the moderation status of an EventMoment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventMoment" } } } } } }, "patch": { "tags": [ "Event \/ Moments" ], "summary": "Update the moderation status of a moment (PENDING \/ APPROVED \/ HIDDEN).", "operationId": "patch_put_event_moment_moderation", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates the moderation status of an EventMoment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventMoment" } } } } } } }, "\/api\/event\/moment\/{identifier}\/file": { "get": { "tags": [ "Event \/ Moments" ], "summary": "Stream the file (audio recording \/ drawing) of a moment for the organizer.", "operationId": "get_get_event_moment_file", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/moment\/share\/{eventIdentifier}": { "get": { "tags": [ "Event \/ Moments" ], "summary": "Share state of the public moments gallery of one event: the link to hand out\nand whether a share password is currently set. The password itself is stored\nas a hash and never returned.", "operationId": "get_get_event_moment_share", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "Event \/ Moments" ], "summary": "Set, change or revoke the share password of the public moments gallery.", "description": "An empty password revokes the share: without a stored password the gallery\nanswers with the same 404 as an unknown token.", "operationId": "put_put_event_moment_share", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Event \/ Moments" ], "summary": "Set, change or revoke the share password of the public moments gallery.", "description": "An empty password revokes the share: without a stored password the gallery\nanswers with the same 404 as an unknown token.", "operationId": "patch_put_event_moment_share", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/moment\/download\/{eventIdentifier}": { "get": { "tags": [ "Event \/ Moments" ], "summary": "State of the temporary ZIP download link of one event.", "operationId": "get_get_event_moment_download", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "Event \/ Moments" ], "summary": "Request a fresh download link. The ZIP is streamed on every download, so the\nlink is READY right away and always delivers the current guestbook.", "description": "Always mints a new token: the previously shared link stops working, which is\nthe only way to take back a link that is already out there.", "operationId": "post_post_event_moment_download", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "Event \/ Moments" ], "summary": "Revoke the download link right away.", "operationId": "delete_delete_event_moment_download", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/public\/moments\/{momentsToken}": { "get": { "tags": [ "Event \/ Moments Public" ], "summary": "Load the moments page data for a moments token (anonymous event token or participant token).", "description": "Returns basic event info plus the participant's own moments when a participant token is used.", "operationId": "get_get_event_moments_public_page", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "momentsToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "Event \/ Moments Public" ], "summary": "Create a new moment (voice message, text, drawing, photo or video) for the event behind the moments token.", "description": "Anonymous via the event moments token, participant-bound via a participant moments token.", "operationId": "post_post_event_moments_public_moment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "momentsToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/public\/moments\/participant_token\/{signUpToken}": { "get": { "tags": [ "Event \/ Moments Public" ], "summary": "Exchange a participant sign-up token for the participant-bound moments token.", "description": "The sign-up token is only known to the participant, so possession of it is\nsufficient proof to hand out the (lazily generated) moments token.", "operationId": "get_get_event_moments_public_participant_token", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "signUpToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/public\/moments\/{momentsToken}\/upload": { "post": { "tags": [ "Event \/ Moments Public" ], "summary": "Announce an upload that will arrive in chunks (large videos).", "description": "Everything that can be judged without the bytes is judged here - type, mime\nand announced size - so a guest is not told about a file that is too large\nafter uploading a gigabyte of it.", "operationId": "post_post_event_moments_public_upload_register", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "momentsToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/public\/moments\/{momentsToken}\/upload\/{uploadToken}\/chunk\/{chunkIndex}": { "put": { "tags": [ "Event \/ Moments Public" ], "summary": "Append one chunk to an announced upload. The body is the raw chunk.", "operationId": "put_put_event_moments_public_upload_chunk", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "momentsToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uploadToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "chunkIndex", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Event \/ Moments Public" ], "summary": "Append one chunk to an announced upload. The body is the raw chunk.", "operationId": "patch_put_event_moments_public_upload_chunk", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "momentsToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uploadToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "chunkIndex", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/public\/moments\/{momentsToken}\/upload\/{uploadToken}\/complete": { "post": { "tags": [ "Event \/ Moments Public" ], "summary": "Turn a finished upload into a moment.", "description": "From here on it is the very same path a small upload takes: real mime\ndetection on the assembled file, size check, storage, background virus scan.", "operationId": "post_post_event_moments_public_upload_complete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "momentsToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uploadToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/public\/moments\/{momentsToken}\/{momentToken}\/file": { "get": { "tags": [ "Event \/ Moments Public" ], "summary": "Stream the file of an own moment (preview after upload).", "description": "The secret moment token is the access capability.", "operationId": "get_get_event_moments_public_file", "parameters": [ { "name": "momentsToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "momentToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/public\/moments\/{momentsToken}\/{momentToken}": { "delete": { "tags": [ "Event \/ Moments Public" ], "summary": "Delete an own moment (GDPR: guests can remove their contribution).", "description": "Soft-deletes the moment and removes the stored file.", "operationId": "delete_delete_event_moments_public_moment", "parameters": [ { "name": "momentsToken", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "momentToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/scanner\/attendancelist\/{listIdentifier}\/{personIdentifier}": { "get": { "tags": [ "Event \/ AttendanceListScanner" ], "summary": "Add a new AttendanceListEntry or close an existing one", "operationId": "get_inwendo_event_attendance_list_entry_scan", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "listIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "personIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add a new AttendanceListEntry or close an existing one", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AttendanceListEntry" } } } } } } }, "\/api\/event\/scanner\/attendancelist\/gantner\/GATAccess\/CardIdentification": { "post": { "tags": [ "Event \/ AttendanceListScanner" ], "summary": "Check isAuthorized for a given Input", "operationId": "post_inwendo_event_attendance_list_entry_gantner_card_identification", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/scanner\/attendancelist\/gantner\/GATAccess\/ActionStarted": { "post": { "tags": [ "Event \/ AttendanceListScanner" ], "summary": "CheckIn \/ CheckOut for a given Input", "operationId": "post_inwendo_event_attendance_list_entry_gantner_action_started", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/scanner\/attendancelist\/gantner\/CardWriter\/CardDetected": { "post": { "tags": [ "Event \/ AttendanceListScanner" ], "summary": "New card registration", "operationId": "post_inwendo_event_attendance_list_entry_gantner_card_detected", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/scanner\/base_event_signup\/next\/{personIdentifier}": { "get": { "tags": [ "Event \/ EventSignUpScanner" ], "summary": "Get a list of the next event signups of a person", "operationId": "get_event_sign_up_scanner_get_next_bookings", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "personIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a list of the next event signups of a person", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventSignUp" } } } } } } } }, "\/api\/event\/scanner\/base_event_signup\/next": { "get": { "tags": [ "Event \/ EventSignUpScanner" ], "summary": "Get a list of the next event signups of a person", "operationId": "get_event_sign_up_scanner_get_next_bookings_no_id", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get a list of the next event signups of a person", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventSignUp" } } } } } } } }, "\/api\/event\/scanner\/base_event_signup\/action\/{personIdentifier}": { "post": { "tags": [ "Event \/ EventSignUpScanner" ], "summary": "Trigger actions for an event signup for a person", "operationId": "post_event_sign_up_scanner_post_action", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "personIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SimpleChange" } }, "type": "object" } } } }, "responses": { "200": { "description": "Trigger actions for an event signup for a person", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp" } } } } } } }, "\/api\/event\/scanner\/base_event_signup\/action": { "post": { "tags": [ "Event \/ EventSignUpScanner" ], "summary": "Trigger actions for an event signup for a person", "operationId": "post_event_sign_up_scanner_post_action_no_id", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SimpleChange" } }, "type": "object" } } } }, "responses": { "200": { "description": "Trigger actions for an event signup for a person", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp" } } } } } } }, "\/api\/event\/base_location": { "get": { "tags": [ "Event \/ BaseLocation" ], "summary": "Returns a list of BaseLocation entries.", "operationId": "get_event_base_location_cget", "parameters": [ { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "locationType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreetLevel", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCity", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressZip", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCountry", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLat", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLng", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isUiFilter", "in": "query", "description": "This property is used to mark an entity as a filter for the frontend | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "inContactCenter", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "slugIdentifier", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Return all BaseLocation", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseLocation" } } } } } } }, "post": { "tags": [ "Event \/ BaseLocation" ], "summary": "Add a new BaseLocation", "operationId": "post_event_base_location_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocation2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseLocation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocation" } } } } } } }, "\/api\/event\/base_location\/{identifier}": { "get": { "tags": [ "Event \/ BaseLocation" ], "summary": "Return a single BaseLocation", "operationId": "get_event_base_location_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a single BaseLocation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocation" } } } } } }, "put": { "tags": [ "Event \/ BaseLocation" ], "summary": "Update a BaseLocation", "operationId": "put_event_base_location_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocation2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseLocation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocation" } } } } } }, "patch": { "tags": [ "Event \/ BaseLocation" ], "summary": "Update a BaseLocation", "operationId": "patch_event_base_location_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocation2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseLocation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocation" } } } } } } }, "\/api\/event\/base_location_plan": { "get": { "tags": [ "Event \/ BaseLocationPlan" ], "summary": "Returns a list of BaseLocationPlan objects", "operationId": "get_event_base_location_plan_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "floorLevel", "in": "query", "description": "Free text floor label, matches BaseBookable::getFloorLevel() | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "planMode", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Order of the floor tabs within one location | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseLocationPlan objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseLocationPlan" } } } } } } }, "post": { "tags": [ "Event \/ BaseLocationPlan" ], "summary": "Add a new BaseLocationPlan", "operationId": "post_event_base_location_plan_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocationPlan2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseLocationPlan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationPlan" } } } } } } }, "\/api\/event\/base_location_plan\/{identifier}": { "get": { "tags": [ "Event \/ BaseLocationPlan" ], "summary": "Returns a single BaseLocationPlan", "operationId": "get_event_base_location_plan_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseLocationPlan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationPlan" } } } } } }, "put": { "tags": [ "Event \/ BaseLocationPlan" ], "summary": "Update a BaseLocationPlan", "operationId": "put_event_base_location_plan_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocationPlan2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseLocationPlan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationPlan" } } } } } }, "patch": { "tags": [ "Event \/ BaseLocationPlan" ], "summary": "Update a BaseLocationPlan", "operationId": "patch_event_base_location_plan_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocationPlan2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseLocationPlan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationPlan" } } } } } } }, "\/api\/event\/base_location_plan\/{identifier}\/items_bulk": { "post": { "tags": [ "Event \/ BaseLocationPlan" ], "summary": "Replaces the placed items of a plan in one request.", "description": "The editor holds the full item state locally and sends it back as a whole, so\nthis is a replace, not a merge: every item in the payload is created or updated,\nand every item of the plan that is missing from the payload is soft deleted.\nThe payload is validated as a whole and written in one transaction, so a half\nsaved plan is impossible. With planUpdated the save is refused (error code 409)\nwhen the plan was saved by someone else since the client loaded it.", "operationId": "post_event_base_location_plan_items_bulk", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "token", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "plan", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "itemType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shape", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "required": [ "items" ], "properties": { "planUpdated": { "description": "updated timestamp of the plan as the client loaded it; when it no longer matches, the save fails with error code 409", "type": "string", "format": "date-time" }, "items": { "description": "Full item state of the plan. Items missing from this list are soft deleted. At most 2000 items.", "type": "array", "items": { "properties": { "id": { "description": "id of an existing item of this plan; missing or foreign ids create a new item", "type": "integer" }, "baseBookable": { "description": "id of the placed object (not archived), null for decoration items", "type": "integer" }, "itemType": { "type": "string", "enum": [ "bookable", "label", "area", "icon", "legend" ] }, "shape": { "type": "string", "enum": [ "rect", "circle", "polygon" ] }, "posX": { "description": "left edge, 0..1 of the plan width", "type": "number" }, "posY": { "description": "top edge, 0..1 of the plan height", "type": "number" }, "width": { "description": "0..1 of the plan width", "type": "number" }, "height": { "description": "0..1 of the plan height", "type": "number" }, "rotation": { "description": "degrees", "type": "number" }, "polygonPoints": { "description": "[[x, y], ...] normalized, only for shape polygon", "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "zIndex": { "type": "integer" }, "label": { "type": "string", "maxLength": 190 }, "icon": { "type": "string", "maxLength": 100 }, "color": { "type": "string" }, "fgColor": { "type": "string" }, "showLabel": { "type": "boolean" }, "showStatus": { "type": "boolean" }, "showNext": { "type": "boolean" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns the stored items of the plan", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseLocationPlanItem" } } } } } } } }, "\/api\/event\/base_location_plan_item": { "get": { "tags": [ "Event \/ BaseLocationPlanItem" ], "summary": "Returns a list of BaseLocationPlanItem objects", "operationId": "get_event_base_location_plan_item_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "token", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "plan", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "itemType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shape", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseLocationPlanItem objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseLocationPlanItem" } } } } } } }, "post": { "tags": [ "Event \/ BaseLocationPlanItem" ], "summary": "Add a new BaseLocationPlanItem", "operationId": "post_event_base_location_plan_item_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocationPlanItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseLocationPlanItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationPlanItem" } } } } } } }, "\/api\/event\/base_location_plan_item\/{identifier}": { "get": { "tags": [ "Event \/ BaseLocationPlanItem" ], "summary": "Returns a single BaseLocationPlanItem", "operationId": "get_event_base_location_plan_item_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseLocationPlanItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationPlanItem" } } } } } }, "put": { "tags": [ "Event \/ BaseLocationPlanItem" ], "summary": "Update a BaseLocationPlanItem", "operationId": "put_event_base_location_plan_item_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocationPlanItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseLocationPlanItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationPlanItem" } } } } } }, "patch": { "tags": [ "Event \/ BaseLocationPlanItem" ], "summary": "Update a BaseLocationPlanItem", "operationId": "patch_event_base_location_plan_item_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocationPlanItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseLocationPlanItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationPlanItem" } } } } } } }, "\/api\/event\/base_location_plan_status": { "get": { "tags": [ "Event \/ BaseLocationPlan Status" ], "summary": "Returns the occupancy of every placed object of a plan at a point in time.", "description": "Either plan or location has to be given. With location the response covers all\nplans of that location, which is what the floor tabs of the board view need.", "operationId": "get_event_base_location_plan_status_get", "parameters": [ { "name": "plan", "in": "query", "description": "Id of the plan", "required": false, "schema": { "type": "integer" } }, { "name": "location", "in": "query", "description": "Id of the location, covers all its plans", "required": false, "schema": { "type": "integer" } }, { "name": "testTime", "in": "query", "description": "Point in time to render, defaults to now. Seconds are dropped: the status is computed and cached per minute.", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "horizonHours", "in": "query", "description": "How far ahead to look for the next booking", "required": false, "schema": { "type": "integer" } }, { "name": "anonymized", "in": "query", "description": "Drop names and booking titles", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Occupancy per placed item", "content": { "application\/json": { "schema": { "properties": { "plans": { "type": "array", "items": { "type": "integer" } }, "test_time": { "type": "string", "format": "date-time" }, "horizon_hours": { "type": "integer" }, "anonymized": { "description": "true when names, participants, trainers and events were dropped", "type": "boolean" }, "soon_threshold_minutes": { "type": "integer" }, "items": { "description": "map of plan item id => status", "type": "object", "additionalProperties": { "properties": { "item": { "type": "integer" }, "base_bookable": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object", "nullable": true }, "status": { "type": "string", "enum": [ "free", "occupied", "soon", "limit_reached", "blocked", "maintenance", "unknown" ] }, "booking_limit": { "type": "integer", "nullable": true }, "parallel_bookings": { "type": "integer" }, "current": { "oneOf": [ { "$ref": "#\/components\/schemas\/LocationPlanStatusBooking" } ], "nullable": true }, "next": { "oneOf": [ { "$ref": "#\/components\/schemas\/LocationPlanStatusBooking" } ], "nullable": true }, "free_until": { "type": "string", "format": "date-time", "nullable": true }, "occupied_until": { "type": "string", "format": "date-time", "nullable": true }, "today_booking_count": { "description": "occupying bookings (no availabilities, no blockings) starting on the day of test_time", "type": "integer" }, "maintenance_due": { "description": "a component of the object is overdue for maintenance", "type": "boolean" }, "maintenance_due_date": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } } }, "type": "object" } } } } } } }, "\/api\/frontend\/contact_center": { "get": { "tags": [ "Event \/ ContactCenter" ], "summary": "Returns a list of contact center entries (main + locations with inContactCenter flag) entries.", "operationId": "get_event_contact_center_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/frontend\/contact_center\/{identifier}": { "get": { "tags": [ "Event \/ ContactCenter" ], "summary": "Return a single contact center entry", "operationId": "get_event_contact_center_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_bookable": { "get": { "tags": [ "Event \/ BaseBookable" ], "summary": "Returns a list of BaseBookable objects", "operationId": "get_event_base_bookable_cget", "parameters": [ { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bookableType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "slugIdentifier", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreetLevel", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCity", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressZip", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCountry", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLat", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLng", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "billingMode", "in": "query", "description": "How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows \"Nutzung erfassen\" only for usage-billed bookables. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "usageBillingInterval", "in": "query", "description": "Billing interval for BILLING_MODE_USAGE: USAGE_BILLING_INTERVAL_PER_BOOKING or USAGE_BILLING_INTERVAL_MONTHLY. Null = use setting event_real_usage_billing_mode. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxActiveBookingsPerUser", "in": "query", "description": "Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxAdvanceBookingHours", "in": "query", "description": "Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "inventoryManaged", "in": "query", "description": "Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "inventoryNumber", "in": "query", "description": "Inventory number of the item (Inventarnummer). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseBookable objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookable" } } } } } } }, "post": { "tags": [ "Event \/ BaseBookable" ], "summary": "Add a new BaseBookable", "operationId": "post_event_base_bookable_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookable17" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseBookable", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookable" } } } } } } }, "\/api\/event\/base_bookable\/{identifier}": { "get": { "tags": [ "Event \/ BaseBookable" ], "summary": "Returns a single BaseBookable", "operationId": "get_event_base_bookable_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseBookable", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookable" } } } } } }, "put": { "tags": [ "Event \/ BaseBookable" ], "summary": "Update a BaseBookable", "operationId": "put_event_base_bookable_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookable17" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookable", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookable" } } } } } }, "patch": { "tags": [ "Event \/ BaseBookable" ], "summary": "Update a BaseBookable", "operationId": "patch_event_base_bookable_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookable17" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookable", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookable" } } } } } } }, "\/api\/event\/smart_lock": { "get": { "tags": [ "DataWarehouse \/ SmartLock" ], "summary": "Returns a list of smart lock entries.", "operationId": "get_event_smart_lock_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContracts", "in": "query", "description": "Linked employment contracts | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "employmentContractGroups", "in": "query", "description": "Linked employment contract groups | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "connection", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "providerDeviceId", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "providerDeviceType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of SmartLocks", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SmartLock" } } } } } } }, "post": { "tags": [ "DataWarehouse \/ SmartLock" ], "summary": "Creates a new smart lock entry.", "operationId": "post_event_smart_lock_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SmartLock2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new SmartLock", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SmartLock" } } } } } } }, "\/api\/event\/smart_lock\/my_accessible": { "get": { "tags": [ "DataWarehouse \/ SmartLock" ], "operationId": "get_event_smart_lock_my_accessible", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns SmartLocks accessible for the current user", "content": { "application\/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "type": { "description": "nuki, loqed, homeassistant, comydo or qrlock", "type": "string", "nullable": true }, "unlock_method": { "description": "remote: unlock opens the door, qr_code: ask for an access code and show it as QR code", "type": "string" } }, "type": "object" } } } } } } } }, "\/api\/event\/smart_lock\/{identifier}": { "get": { "tags": [ "DataWarehouse \/ SmartLock" ], "summary": "Returns a single smart lock entry.", "operationId": "get_event_smart_lock_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single SmartLock", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SmartLock" } } } } } }, "put": { "tags": [ "DataWarehouse \/ SmartLock" ], "summary": "Updates an existing smart lock entry.", "operationId": "put_event_smart_lock_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SmartLock2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a SmartLock", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SmartLock" } } } } } }, "patch": { "tags": [ "DataWarehouse \/ SmartLock" ], "summary": "Updates an existing smart lock entry.", "operationId": "patch_event_smart_lock_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SmartLock2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a SmartLock", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SmartLock" } } } } } } }, "\/api\/event\/smart_lock\/{identifier}\/lock": { "post": { "tags": [ "DataWarehouse \/ SmartLock" ], "summary": "Locks the entry.", "operationId": "post_event_smart_lock_lock", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/smart_lock\/{identifier}\/unlock": { "post": { "tags": [ "DataWarehouse \/ SmartLock" ], "summary": "Unlocks the entry.", "operationId": "post_event_smart_lock_unlock", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/smart_lock\/{identifier}\/status": { "get": { "tags": [ "DataWarehouse \/ SmartLock" ], "summary": "Returns the current status.", "operationId": "get_event_smart_lock_status", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/smart_lock\/{identifier}\/access_code": { "post": { "tags": [ "DataWarehouse \/ SmartLock" ], "summary": "Issues a code that opens a Comydo or QRLock smart lock for {@see SmartLockAccessCodeService::VALID_SECONDS}\nseconds; the app shows it as QR code at the scanner.", "operationId": "post_event_smart_lock_access_code", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The access code", "content": { "application\/json": { "schema": { "properties": { "code": { "type": "string" }, "valid_until": { "type": "string", "format": "date-time" }, "valid_seconds": { "type": "integer" } }, "type": "object" } } } } } } }, "\/api\/event\/smart_lock_connection": { "get": { "tags": [ "DataWarehouse \/ SmartLockConnection" ], "summary": "Returns a list of smart lock connection entries.", "operationId": "get_event_smart_lock_connection_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bridgeHost", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bridgePort", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "webClientId", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "loqedLockId", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of SmartLockConnections", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SmartLockConnection" } } } } } } }, "post": { "tags": [ "DataWarehouse \/ SmartLockConnection" ], "summary": "Creates a new smart lock connection entry.", "operationId": "post_event_smart_lock_connection_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SmartLockConnection2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new SmartLockConnection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SmartLockConnection" } } } } } } }, "\/api\/event\/smart_lock_connection\/{identifier}": { "get": { "tags": [ "DataWarehouse \/ SmartLockConnection" ], "summary": "Returns a single smart lock connection entry.", "operationId": "get_event_smart_lock_connection_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single SmartLockConnection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SmartLockConnection" } } } } } }, "put": { "tags": [ "DataWarehouse \/ SmartLockConnection" ], "summary": "Updates an existing smart lock connection entry.", "operationId": "put_event_smart_lock_connection_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SmartLockConnection2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a SmartLockConnection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SmartLockConnection" } } } } } }, "patch": { "tags": [ "DataWarehouse \/ SmartLockConnection" ], "summary": "Updates an existing smart lock connection entry.", "operationId": "patch_event_smart_lock_connection_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/SmartLockConnection2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a SmartLockConnection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SmartLockConnection" } } } } } } }, "\/api\/event\/smart_lock_connection\/{identifier}\/oauth_login": { "post": { "tags": [ "DataWarehouse \/ SmartLockConnection" ], "summary": "Starts the OAuth login with an external provider.", "operationId": "post_event_smart_lock_connection_oauth_login", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/smart_lock_connection\/{identifier}\/sync_devices": { "post": { "tags": [ "DataWarehouse \/ SmartLockConnection" ], "summary": "Synchronizes the devices.", "operationId": "post_event_smart_lock_connection_sync_devices", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/smart_lock_log": { "get": { "tags": [ "DataWarehouse \/ SmartLockLog" ], "summary": "Returns a list of smart lock log entries.", "operationId": "get_event_smart_lock_log_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "smartLock", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Person of a card or member card scan, which may have no user account (Node-RED access check). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "action", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Where the action came from: app (also the API), homeassistant, nodered, n8n or the scan webhook provider (comydo). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of SmartLockLogs", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SmartLockLog" } } } } } } } }, "\/api\/event\/smart_lock_log\/{identifier}": { "get": { "tags": [ "DataWarehouse \/ SmartLockLog" ], "summary": "Returns a single smart lock log entry.", "operationId": "get_event_smart_lock_log_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single SmartLockLog", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SmartLockLog" } } } } } } }, "\/api\/event\/external_display": { "get": { "tags": [ "Event \/ External Display" ], "summary": "Returns a list of ExternalDisplays", "operationId": "get_event_external_display_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deviceType", "in": "query", "description": "Which kind of device this is, and therefore which driver renders for it. Today only the built-in e-paper renderer exists; a third-party display API becomes an additional type plus an additional driver, nothing else. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "Public identifier of the device, travelling in the request path. Deliberately not the secret: paths end up in access logs, proxy logs and support screenshots. Keeping an id there lets a device be identified in a log without the credential riding along. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contentProfile", "in": "query", "description": "How much this particular sign is allowed to say. A door sign is a publicly visible output channel: that the renderer may read the data does not mean the sign may show it. The profile sits on the display, not on the room, because the same room can carry a hallway sign and a staff-side sign. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language every word on this frame is rendered in. Sits on the display, not on the installation: a foyer board in a bilingual building can want English while the door signs behind it stay German. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "showBookingQr", "in": "query", "description": "Show a booking QR code when the bookable is free. Only honoured when the bookable actually accepts self-service bookings - a code that leads nowhere is worse than no code. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "lastSeenAt", "in": "query", "description": "Last successful fetch by the device. No log table on purpose: a display checks in every few minutes, which is roughly 288 rows per device per day, and only the last one is ever read. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of ExternalDisplays", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ExternalDisplay" } } } } } } }, "post": { "tags": [ "Event \/ External Display" ], "summary": "Adds a new ExternalDisplay", "operationId": "post_event_external_display_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ExternalDisplay2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new ExternalDisplay", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExternalDisplay" } } } } } } }, "\/api\/event\/external_display\/{identifier}": { "get": { "tags": [ "Event \/ External Display" ], "summary": "Returns a single ExternalDisplay", "operationId": "get_event_external_display_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single ExternalDisplay", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExternalDisplay" } } } } } }, "put": { "tags": [ "Event \/ External Display" ], "summary": "Updates an ExternalDisplay", "operationId": "put_event_external_display_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ExternalDisplay2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an ExternalDisplay", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExternalDisplay" } } } } } }, "delete": { "tags": [ "Event \/ External Display" ], "summary": "Deletes a single ExternalDisplay", "operationId": "delete_event_external_display_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single ExternalDisplay", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExternalDisplay" } } } } } }, "patch": { "tags": [ "Event \/ External Display" ], "summary": "Updates an ExternalDisplay", "operationId": "patch_event_external_display_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/ExternalDisplay2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an ExternalDisplay", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ExternalDisplay" } } } } } } }, "\/api\/event\/external_display\/{identifier}\/credentials": { "get": { "tags": [ "Event \/ External Display" ], "summary": "Returns what has to be flashed onto a device: its image URL and its secret.", "description": "Separate from the detail endpoint so the secret is fetched deliberately and\nappears in exactly one response, instead of riding along in every list the\nmanagement UI loads.", "operationId": "get_event_external_display_credentials", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Device credentials", "content": { "application\/json": { "schema": { "properties": { "device_id": { "type": "string" }, "image_url": { "type": "string" }, "secret": { "type": "string" }, "previous_secret": { "type": "string", "nullable": true }, "previous_secret_valid_until": { "type": "string", "nullable": true }, "refresh_seconds": { "type": "integer" } }, "type": "object" } } } } } } }, "\/api\/event\/external_display\/{identifier}\/rotate_secret": { "post": { "tags": [ "Event \/ External Display" ], "summary": "Issues a new secret, keeping the old one valid for a grace period.", "description": "Two secrets have to work at once: a rotation that does not reach the device\nwould otherwise leave a dead sign on a customer wall, and nobody notices\nuntil someone walks past it.", "operationId": "post_event_external_display_rotate_secret", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/external_display\/{identifier}\/preview.png": { "get": { "tags": [ "Event \/ External Display" ], "summary": "Renders the current frame as a PNG for the management UI.", "description": "The same pixels the device receives, before packing, so what an admin sees\non screen is what is hanging on the wall.", "operationId": "get_event_external_display_preview", "parameters": [ { "name": "now", "in": "query", "description": "Render a different time of the same day (HH:MM)", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Current frame", "content": { "image\/png": [] } } } } }, "\/api\/event\/kiosk_device": { "get": { "tags": [ "Event \/ Kiosk Device" ], "summary": "Returns a list of KioskDevices", "operationId": "get_event_kiosk_device_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "description": "Public identifier of the device, sent in the x-iw-kiosk-device-id header. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "lastSeenAt", "in": "query", "description": "Last request of the device. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of KioskDevices", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/KioskDevice" } } } } } } }, "post": { "tags": [ "Event \/ Kiosk Device" ], "summary": "Adds a new KioskDevice", "operationId": "post_event_kiosk_device_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/KioskDevice2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new KioskDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/KioskDevice" } } } } } } }, "\/api\/event\/kiosk_device\/{identifier}": { "get": { "tags": [ "Event \/ Kiosk Device" ], "summary": "Returns a single KioskDevice", "operationId": "get_event_kiosk_device_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single KioskDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/KioskDevice" } } } } } }, "put": { "tags": [ "Event \/ Kiosk Device" ], "summary": "Updates a KioskDevice", "operationId": "put_event_kiosk_device_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/KioskDevice2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a KioskDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/KioskDevice" } } } } } }, "delete": { "tags": [ "Event \/ Kiosk Device" ], "summary": "Deletes a single KioskDevice", "operationId": "delete_event_kiosk_device_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single KioskDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/KioskDevice" } } } } } }, "patch": { "tags": [ "Event \/ Kiosk Device" ], "summary": "Updates a KioskDevice", "operationId": "patch_event_kiosk_device_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/KioskDevice2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a KioskDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/KioskDevice" } } } } } } }, "\/api\/event\/kiosk_device\/{identifier}\/pairing": { "get": { "tags": [ "Event \/ Kiosk Device" ], "summary": "Returns the pairing code the kiosk app scans or receives typed in.", "description": "Separate from the detail endpoint so the secret is fetched deliberately and\nappears in exactly one response.", "operationId": "get_event_kiosk_device_pairing", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Pairing code", "content": { "application\/json": { "schema": { "properties": { "device_id": { "type": "string" }, "pairing_code": { "type": "string" } }, "type": "object" } } } } } } }, "\/api\/event\/kiosk_device\/{identifier}\/rotate_secret": { "post": { "tags": [ "Event \/ Kiosk Device" ], "summary": "Issues a new secret and ends the running session. The kiosk has to be\npaired again with the new code.", "operationId": "post_event_kiosk_device_rotate_secret", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/kiosk\/config": { "get": { "tags": [ "Event \/ Kiosk" ], "summary": "Configuration of the kiosk for a paired device. Also the pairing check of\nthe app: a device that gets an answer here is paired.", "operationId": "get_event_kiosk_config", "parameters": [ { "name": "x-iw-kiosk-device-id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "x-iw-kiosk-device-secret", "in": "header", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Kiosk configuration", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/event\/kiosk\/session": { "post": { "tags": [ "Event \/ Kiosk" ], "summary": "Logs a member in by the scanned member card (profile JWT, or the verify\nURL of its QR code). A member number is not accepted.", "operationId": "post_event_kiosk_session", "parameters": [ { "name": "x-iw-kiosk-device-id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "x-iw-kiosk-device-secret", "in": "header", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "card": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Kiosk session", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/event\/kiosk\/logout": { "post": { "tags": [ "Event \/ Kiosk" ], "summary": "Ends the kiosk session on the device (logout button or inactivity).", "operationId": "post_event_kiosk_logout", "parameters": [ { "name": "x-iw-kiosk-device-id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "x-iw-kiosk-device-secret", "in": "header", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Logged out", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/event\/kiosk\/me\/entries": { "get": { "tags": [ "Event \/ Kiosk" ], "summary": "The dates of the logged-in member with the actions the kiosk offers.", "operationId": "get_event_kiosk_entries", "parameters": [ { "name": "x-iw-kiosk-device-id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "x-iw-kiosk-device-secret", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "x-iw-kiosk-session", "in": "header", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Dates of the member", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/event\/kiosk\/me\/sign_ups\/{signUpId}\/check_in": { "post": { "tags": [ "Event \/ Kiosk" ], "summary": "Self check-in for a current date.", "operationId": "post_event_kiosk_check_in", "parameters": [ { "name": "x-iw-kiosk-device-id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "x-iw-kiosk-device-secret", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "x-iw-kiosk-session", "in": "header", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "signUpId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Dates of the member after the check-in", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/event\/kiosk\/me\/sign_ups\/{signUpId}\/follow_up": { "post": { "tags": [ "Event \/ Kiosk" ], "summary": "Sign-up for the next date of the course of a sign-up.", "operationId": "post_event_kiosk_follow_up", "parameters": [ { "name": "x-iw-kiosk-device-id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "x-iw-kiosk-device-secret", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "x-iw-kiosk-session", "in": "header", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "signUpId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Dates of the member after the sign-up", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/api\/event\/base_bookable_component": { "get": { "tags": [ "Event \/ BaseBookableComponent" ], "summary": "Returns a list of BaseBookableComponent objects", "operationId": "get_event_base_bookable_component_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseBookableComponent objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableComponent" } } } } } } }, "post": { "tags": [ "Event \/ BaseBookableComponent" ], "summary": "Add a new BaseBookableComponent", "operationId": "post_event_base_bookable_component_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookableComponent2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseBookableComponent", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableComponent" } } } } } } }, "\/api\/event\/base_bookable_component\/{identifier}": { "get": { "tags": [ "Event \/ BaseBookableComponent" ], "summary": "Returns a single BaseBookableComponent", "operationId": "get_event_base_bookable_component_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseBookableComponent", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableComponent" } } } } } }, "put": { "tags": [ "Event \/ BaseBookableComponent" ], "summary": "Update a BaseBookableComponent", "operationId": "put_event_base_bookable_component_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookableComponent2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookableComponent", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableComponent" } } } } } }, "patch": { "tags": [ "Event \/ BaseBookableComponent" ], "summary": "Update a BaseBookableComponent", "operationId": "patch_event_base_bookable_component_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookableComponent2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookableComponent", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableComponent" } } } } } } }, "\/api\/event\/base_bookable_usage_counter": { "get": { "tags": [ "Event \/ BaseBookableUsageCounter" ], "summary": "Returns a list of base bookable usage counter entries.", "operationId": "get_event_base_bookable_usage_counter_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookableComponent", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseBookableUsageCounter objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableUsageCounter" } } } } } } }, "post": { "tags": [ "Event \/ BaseBookableUsageCounter" ], "summary": "Creates a new base bookable usage counter entry.", "operationId": "post_event_base_bookable_usage_counter_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookableUsageCounter2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseBookableUsageCounter", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableUsageCounter" } } } } } } }, "\/api\/event\/base_bookable_usage_counter\/{identifier}": { "get": { "tags": [ "Event \/ BaseBookableUsageCounter" ], "summary": "Returns a single base bookable usage counter entry.", "operationId": "get_event_base_bookable_usage_counter_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseBookableUsageCounter", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableUsageCounter" } } } } } }, "put": { "tags": [ "Event \/ BaseBookableUsageCounter" ], "summary": "Updates an existing base bookable usage counter entry.", "operationId": "put_event_base_bookable_usage_counter_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookableUsageCounter2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookableUsageCounter", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableUsageCounter" } } } } } }, "patch": { "tags": [ "Event \/ BaseBookableUsageCounter" ], "summary": "Updates an existing base bookable usage counter entry.", "operationId": "patch_event_base_bookable_usage_counter_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookableUsageCounter2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookableUsageCounter", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableUsageCounter" } } } } } } }, "\/api\/event\/base_booking_real_usage": { "get": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Returns a list of base booking real usage entries.", "operationId": "get_event_base_booking_real_usage_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "token", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBooking", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseBookingRealUsage objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage" } } } } } } }, "post": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Creates a new base booking real usage entry.", "operationId": "post_event_base_booking_real_usage_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseBookingRealUsage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage" } } } } } } }, "\/api\/event\/base_booking_real_usage\/{identifier}": { "get": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Returns a single base booking real usage entry.", "operationId": "get_event_base_booking_real_usage_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseBookingRealUsage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage" } } } } } }, "put": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Updates an existing base booking real usage entry.", "operationId": "put_event_base_booking_real_usage_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookingRealUsage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage" } } } } } }, "patch": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Updates an existing base booking real usage entry.", "operationId": "patch_event_base_booking_real_usage_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookingRealUsage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage" } } } } } } }, "\/api\/event\/base_booking_real_usage_customer": { "get": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Get all BaseBookingRealUsage records of the customer's own bookings", "operationId": "get_event_base_booking_real_usage_cget_customer", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "token", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBooking", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all BaseBookingRealUsage records of the customer's own bookings", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage" } } } } } } } }, "\/api\/event\/customer\/base_booking_real_usage": { "post": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Add a new BaseBookingRealUsage for an own booking as a customer", "operationId": "post_event_base_booking_real_usage_post_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseBookingRealUsage for an own booking as a customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage" } } } } } } }, "\/api\/event\/customer\/base_booking_real_usage\/{identifier}": { "put": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Update a BaseBookingRealUsage of an own booking as a customer", "operationId": "put_event_base_booking_real_usage_put_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookingRealUsage of an own booking as a customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage" } } } } } }, "patch": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Update a BaseBookingRealUsage of an own booking as a customer", "operationId": "patch_event_base_booking_real_usage_put_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookingRealUsage of an own booking as a customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsage" } } } } } } }, "\/api\/event\/base_booking_real_usage_statistics\/summary": { "get": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Aggregated real usage statistics (block\/flight minutes, landings) by bookable, person,\ncontent type and month.", "operationId": "get_event_base_booking_real_usage_statistics_summary", "parameters": [ { "name": "baseBookable", "in": "query", "description": "Filter by bookable id", "required": false, "schema": { "type": "integer" } }, { "name": "participant", "in": "query", "description": "Filter by booking participant (person id)", "required": false, "schema": { "type": "integer" } }, { "name": "contentType", "in": "query", "description": "Filter by booking content type id", "required": false, "schema": { "type": "integer" } }, { "name": "startTime", "in": "query", "description": "Only usages of bookings starting at\/after this date", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Only usages of bookings starting at\/before this date", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_booking_real_usage_logbook\/pdf": { "get": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Pilot logbook of a person as PDF: one row per flight leg, times in UTC, with the person's\nfunction (PIC \/ dual \/ instructor). A member gets their own logbook; with read access to\nevent bookings any person's logbook can be requested via `person`.", "operationId": "get_event_base_booking_real_usage_logbook_pdf", "parameters": [ { "name": "person", "in": "query", "description": "Person id (requires read access to event bookings unless it is the own person)", "required": false, "schema": { "type": "integer" } }, { "name": "startTime", "in": "query", "description": "Only flights of bookings starting at\/after this date", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Only flights of bookings starting at\/before this date", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_booking_real_usage_section": { "get": { "tags": [ "Event \/ BaseBookingRealUsageSection" ], "summary": "Returns a list of base booking real usage section entries.", "operationId": "get_event_base_booking_real_usage_section_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "token", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookingRealUsage", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startBaseLocation", "in": "query", "description": "Master record for startLocation (e.g. airport, matched via shortIdentifier = ICAO code) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "endBaseLocation", "in": "query", "description": "Master record for endLocation (e.g. airport, matched via shortIdentifier = ICAO code) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseBookingRealUsageSection objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection" } } } } } } }, "post": { "tags": [ "Event \/ BaseBookingRealUsageSection" ], "summary": "Creates a new base booking real usage section entry.", "operationId": "post_event_base_booking_real_usage_section_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseBookingRealUsageSection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection" } } } } } } }, "\/api\/event\/base_booking_real_usage_section\/{identifier}": { "get": { "tags": [ "Event \/ BaseBookingRealUsageSection" ], "summary": "Returns a single base booking real usage section entry.", "operationId": "get_event_base_booking_real_usage_section_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseBookingRealUsageSection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection" } } } } } }, "put": { "tags": [ "Event \/ BaseBookingRealUsageSection" ], "summary": "Updates an existing base booking real usage section entry.", "operationId": "put_event_base_booking_real_usage_section_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookingRealUsageSection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection" } } } } } }, "patch": { "tags": [ "Event \/ BaseBookingRealUsageSection" ], "summary": "Updates an existing base booking real usage section entry.", "operationId": "patch_event_base_booking_real_usage_section_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookingRealUsageSection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection" } } } } } } }, "\/api\/event\/customer\/base_booking_real_usage_section": { "post": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Add a new BaseBookingRealUsageSection for a usage record of an own booking as a customer", "operationId": "post_event_base_booking_real_usage_section_post_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseBookingRealUsageSection for a usage record of an own booking as a customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection" } } } } } } }, "\/api\/event\/customer\/base_booking_real_usage_section\/{identifier}": { "put": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Update a BaseBookingRealUsageSection of an own booking's usage record as a customer", "operationId": "put_event_base_booking_real_usage_section_put_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookingRealUsageSection of an own booking's usage record as a customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection" } } } } } }, "patch": { "tags": [ "Event \/ BaseBookingRealUsage" ], "summary": "Update a BaseBookingRealUsageSection of an own booking's usage record as a customer", "operationId": "patch_event_base_booking_real_usage_section_put_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookingRealUsageSection of an own booking's usage record as a customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingRealUsageSection" } } } } } } }, "\/api\/event\/booking_content_type": { "get": { "tags": [ "Event \/ BookingContentType" ], "summary": "Returns a list of booking content type entries.", "operationId": "get_event_booking_content_type_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shortName", "in": "query", "description": "Kurzname for compact UI labels (e.g. calendars, badges). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "appointment", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "availability", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "color", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "selfServiceSelectable", "in": "query", "description": "Whether this content type may be picked by a customer \/ trainer in the self service portal. Off by default so existing installations keep the current behaviour. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "trainerAvailabilityMode", "in": "query", "description": "Controls whether a self service booking of this content type also picks the availability of a trainer: NONE (default), OPTIONAL or REQUIRED. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BookingContentType objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BookingContentType" } } } } } } }, "post": { "tags": [ "Event \/ BookingContentType" ], "summary": "Creates a new booking content type entry.", "operationId": "post_event_booking_content_type_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BookingContentType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BookingContentType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BookingContentType" } } } } } } }, "\/api\/event\/booking_content_type\/{identifier}": { "get": { "tags": [ "Event \/ BookingContentType" ], "summary": "Returns a single booking content type entry.", "operationId": "get_event_booking_content_type_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BookingContentType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BookingContentType" } } } } } }, "put": { "tags": [ "Event \/ BookingContentType" ], "summary": "Updates an existing booking content type entry.", "operationId": "put_event_booking_content_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BookingContentType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BookingContentType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BookingContentType" } } } } } }, "patch": { "tags": [ "Event \/ BookingContentType" ], "summary": "Updates an existing booking content type entry.", "operationId": "patch_event_booking_content_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BookingContentType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BookingContentType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BookingContentType" } } } } } } }, "\/api\/event\/base_event_bib_range": { "get": { "tags": [ "Event \/ BaseEventBibRange" ], "summary": "Returns a list of base event bib range entries.", "operationId": "get_event_base_event_bib_range_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "prefix", "in": "query", "description": "Fixed prefix for this range, wins over the global prefix mode. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "rangeStart", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "rangeEnd", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "priority", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseEventBibRange objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventBibRange" } } } } } } }, "post": { "tags": [ "Event \/ BaseEventBibRange" ], "summary": "Creates a new base event bib range entry.", "operationId": "post_event_base_event_bib_range_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventBibRange2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseEventBibRange", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventBibRange" } } } } } } }, "\/api\/event\/base_event_bib_range\/{identifier}": { "get": { "tags": [ "Event \/ BaseEventBibRange" ], "summary": "Returns a single base event bib range entry.", "operationId": "get_event_base_event_bib_range_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseEventBibRange", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventBibRange" } } } } } }, "put": { "tags": [ "Event \/ BaseEventBibRange" ], "summary": "Updates an existing base event bib range entry.", "operationId": "put_event_base_event_bib_range_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventBibRange2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseEventBibRange", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventBibRange" } } } } } }, "delete": { "tags": [ "Event \/ BaseEventBibRange" ], "summary": "Deletes an archived BaseEventBibRange. Assigned numbers stay, only the link to the range is removed.", "operationId": "delete_event_base_event_bib_range_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single BaseEventBibRange", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventBibRange" } } } } } }, "patch": { "tags": [ "Event \/ BaseEventBibRange" ], "summary": "Updates an existing base event bib range entry.", "operationId": "patch_event_base_event_bib_range_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventBibRange2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseEventBibRange", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventBibRange" } } } } } } }, "\/api\/event\/base_event\/{identifier}\/bib_number\/stats": { "get": { "tags": [ "Event \/ BibNumber" ], "summary": "Stats of the bib numbers of an event: mode, assigned, pending and usage per range.", "operationId": "get_event_base_event_bib_number_stats", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bib number stats" } } } }, "\/api\/event\/base_event\/{identifier}\/bib_number\/assign": { "post": { "tags": [ "Event \/ BibNumber" ], "summary": "Assigns numbers to every sign up of the event without one. With dry_run only the preview is returned.", "operationId": "post_event_base_event_bib_number_assign", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "sort_mode": { "type": "string", "enum": [ "CREATED", "LAST_NAME", "BIRTHDAY", "AGE_CLASS", "COMPANY" ] }, "dry_run": { "type": "boolean" }, "only_confirmed": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Assigned and skipped sign ups" } } } }, "\/api\/event\/base_event\/{identifier}\/bib_number\/swap": { "post": { "tags": [ "Event \/ BibNumber" ], "summary": "Exchanges the numbers of two sign ups of the event.", "operationId": "post_event_base_event_bib_number_swap", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "sign_up_a": { "type": "integer" }, "sign_up_b": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "success" } } } }, "\/api\/event\/base_event_signup\/{identifier}\/bib_number": { "put": { "tags": [ "Event \/ BibNumber" ], "summary": "Sets or removes the bib number and\/or the chip code of a sign up. Only the keys sent are changed.", "operationId": "put_event_base_event_signup_bib_number_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "bib_label": { "type": "string", "nullable": true }, "chip_code": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "The updated sign up", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } }, "patch": { "tags": [ "Event \/ BibNumber" ], "summary": "Sets or removes the bib number and\/or the chip code of a sign up. Only the keys sent are changed.", "operationId": "patch_event_base_event_signup_bib_number_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "bib_label": { "type": "string", "nullable": true }, "chip_code": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "The updated sign up", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "\/api\/event\/public\/ticket_shop\/{identifier}": { "get": { "tags": [ "Event \/ Tickets" ], "summary": "Ticket shop of an event: ticket categories with price, sale state and tickets left, max tickets per\norder and whether tickets are personalized. Logged in, member prices of the selected person are offered.", "description": "Not cached: tickets left change with every order.", "operationId": "get_event_ticket_shop_public", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket shop of the event" } } } }, "\/api\/event\/public\/ticket_seating\/{identifier}": { "get": { "tags": [ "Event \/ Tickets" ], "summary": "Seating plan of an event for the seat selection: the plan, its seats and decoration and the ids of the\nseats taken. \"active\" is false while the event has no seating plan or the setting\nevent_ticket_seating_enabled is off. Not cached: seats are taken with every order.", "operationId": "get_event_ticket_seating_public", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Seating plan of the event" } } } }, "\/api\/event\/public\/ticket_order\/{token}": { "get": { "tags": [ "Event \/ Tickets" ], "summary": "An order with its tickets (codes, status, payment), opened with the token of the order.", "operationId": "get_event_ticket_order_public", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The order with its tickets" } } } }, "\/api\/event\/customer\/ticket\/event\/{identifier}": { "get": { "tags": [ "Event \/ Tickets" ], "summary": "The own tickets (of the selected household) for an event, with their QR codes.", "operationId": "get_event_ticket_customer_event", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tickets of the household for the event" } } } }, "\/api\/event\/public\/ticket_key": { "get": { "tags": [ "Event \/ Tickets" ], "summary": "Public key of the ticket QR codes (JWT, RS256) for scanners that verify a ticket themselves.", "operationId": "get_event_ticket_public_key", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "kid, alg, sub and the public key (PEM)" } } } }, "\/api\/event\/ticket\/{code}": { "get": { "tags": [ "Event \/ Tickets" ], "summary": "Looks a ticket up without checking it in.", "operationId": "get_event_ticket_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The ticket" } } } }, "\/api\/event\/ticket\/{code}\/check_in": { "post": { "tags": [ "Event \/ Tickets" ], "summary": "Checks a ticket in (entrance). `code` is the ticket code or the scanned QR code (signed JWT). With `?event=` the ticket must belong to that event.", "description": "Refused: unknown code 1594, other event 1598, cancelled 1596, checked in already 1595 (with the time),\nunpaid 1597 (ignorable with x-ignore-iw-error-code: 1597 or the setting event_ticket_check_in_allow_unpaid).", "operationId": "post_event_ticket_check_in", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The checked in ticket" } } }, "delete": { "tags": [ "Event \/ Tickets" ], "summary": "Takes a check-in back.", "operationId": "delete_event_ticket_check_in_undo", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The ticket" } } } }, "\/api\/event\/base_event\/{identifier}\/ticket_stats": { "get": { "tags": [ "Event \/ Tickets" ], "summary": "Ticket overview of an event: per category quota, sold (paid \/ payment open), checked in, revenue; totals.", "operationId": "get_event_base_event_ticket_stats", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket overview" } } } }, "\/api\/event\/timing_point": { "get": { "tags": [ "Event \/ EventTimingPoint" ], "summary": "Returns a list of event timing point entries.", "operationId": "get_event_timing_point_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "pointType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "distanceMeters", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EventTimingPoint objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventTimingPoint" } } } } } } }, "post": { "tags": [ "Event \/ EventTimingPoint" ], "summary": "Creates a new event timing point entry.", "operationId": "post_event_timing_point_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventTimingPoint2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new EventTimingPoint", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingPoint" } } } } } } }, "\/api\/event\/timing_point\/{identifier}": { "get": { "tags": [ "Event \/ EventTimingPoint" ], "summary": "Returns a single event timing point entry.", "operationId": "get_event_timing_point_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EventTimingPoint", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingPoint" } } } } } }, "put": { "tags": [ "Event \/ EventTimingPoint" ], "summary": "Updates an existing event timing point entry.", "operationId": "put_event_timing_point_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventTimingPoint2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EventTimingPoint", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingPoint" } } } } } }, "delete": { "tags": [ "Event \/ EventTimingPoint" ], "summary": "Deletes an archived EventTimingPoint. Reads keep their data, only the link to the point is removed.", "operationId": "delete_event_timing_point_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single EventTimingPoint", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingPoint" } } } } } }, "patch": { "tags": [ "Event \/ EventTimingPoint" ], "summary": "Updates an existing event timing point entry.", "operationId": "patch_event_timing_point_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventTimingPoint2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EventTimingPoint", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingPoint" } } } } } } }, "\/api\/event\/timing_device": { "get": { "tags": [ "Event \/ EventTimingDevice" ], "summary": "Returns a list of event timing device entries.", "operationId": "get_event_timing_device_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deviceType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "timingPoint", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "lastSeenAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EventTimingDevice objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventTimingDevice" } } } } } } }, "post": { "tags": [ "Event \/ EventTimingDevice" ], "summary": "Creates a new event timing device entry.", "operationId": "post_event_timing_device_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventTimingDevice2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new EventTimingDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingDevice" } } } } } } }, "\/api\/event\/timing_device\/{identifier}": { "get": { "tags": [ "Event \/ EventTimingDevice" ], "summary": "Returns a single event timing device entry.", "operationId": "get_event_timing_device_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EventTimingDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingDevice" } } } } } }, "put": { "tags": [ "Event \/ EventTimingDevice" ], "summary": "Updates an existing event timing device entry.", "operationId": "put_event_timing_device_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventTimingDevice2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EventTimingDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingDevice" } } } } } }, "delete": { "tags": [ "Event \/ EventTimingDevice" ], "summary": "Deletes an archived EventTimingDevice. Its reads stay.", "operationId": "delete_event_timing_device_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single EventTimingDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingDevice" } } } } } }, "patch": { "tags": [ "Event \/ EventTimingDevice" ], "summary": "Updates an existing event timing device entry.", "operationId": "patch_event_timing_device_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventTimingDevice2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EventTimingDevice", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingDevice" } } } } } } }, "\/api\/event\/timing_device\/{identifier}\/regenerate_token": { "post": { "tags": [ "Event \/ EventTimingDevice" ], "summary": "Creates a new secret for the device; the old one stops working immediately.", "operationId": "post_event_timing_device_regenerate_token", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The device with its new token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingDevice3" } } } } } } }, "\/api\/event\/timing_read": { "get": { "tags": [ "Event \/ EventTimingRead" ], "summary": "Returns a list of event timing read entries.", "operationId": "get_event_timing_read_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "timingPoint", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "signUp", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "device", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "rawBib", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "rawChip", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "readTime", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "readTimeMs", "in": "query", "description": "Unix time in milliseconds (device clock corrected by its offset). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "externalId", "in": "query", "description": "Id of the read at its source (device sequence number, CSV row), used for idempotency. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EventTimingRead objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventTimingRead" } } } } } } }, "post": { "tags": [ "Event \/ EventTimingRead" ], "summary": "Manual read, e.g. typed in at the finish line. Without read_time_ms the server time is used.", "operationId": "post_event_timing_read_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "base_event": { "type": "integer" }, "timing_point": { "type": "integer" }, "bib": { "type": "string" }, "sign_up": { "type": "integer" }, "read_time_ms": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "{results: [ReadResult]}" } } } }, "\/api\/event\/timing_read\/batch": { "post": { "tags": [ "Event \/ EventTimingRead" ], "summary": "Several reads at once, e.g. from an app or an external timing system.", "operationId": "post_event_timing_read_batch", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "base_event": { "type": "integer" }, "reads": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "{results: [ReadResult]}" } } } }, "\/api\/event\/timing_read\/{identifier}": { "put": { "tags": [ "Event \/ EventTimingRead" ], "summary": "Correction of a read: status (e.g. IGNORED), assigned sign up or timing point.", "operationId": "put_event_timing_read_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "status": { "type": "string" }, "sign_up": { "type": "integer", "nullable": true }, "timing_point": { "type": "integer", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "The updated read", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingRead" } } } } } }, "patch": { "tags": [ "Event \/ EventTimingRead" ], "summary": "Correction of a read: status (e.g. IGNORED), assigned sign up or timing point.", "operationId": "patch_event_timing_read_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "status": { "type": "string" }, "sign_up": { "type": "integer", "nullable": true }, "timing_point": { "type": "integer", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "The updated read", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingRead" } } } } } } }, "\/api\/event\/base_event\/{identifier}\/timing\/import_csv": { "post": { "tags": [ "Event \/ EventTimingRead" ], "summary": "CSV import (multipart field \"file\"), see docs\/event\/STARTNUMMERN_ZEITMESSUNG.md.", "operationId": "post_event_base_event_timing_import_csv", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart\/form-data": { "schema": { "properties": { "file": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "{results, created, duplicates, unassigned, errors}" } } } }, "\/api\/event\/scoreboard_activity": { "get": { "tags": [ "Event \/ EventScoreboardActivity" ], "summary": "Returns a list of event scoreboard activity entries.", "operationId": "get_event_scoreboard_activity_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "activityType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "side", "in": "query", "description": "HOME, AWAY or null (phase changes, notes). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "points", "in": "query", "description": "Points of a SCORE entry (1 for a goal, 1\/2\/3 in basketball). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "minute", "in": "query", "description": "Match minute, as entered. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Period (half, quarter, set) the entry belongs to; set from the match state when empty. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "playerName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "playerNumber", "in": "query", "description": "Jersey number. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EventScoreboardActivity objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventScoreboardActivity" } } } } } } }, "post": { "tags": [ "Event \/ EventScoreboardActivity" ], "summary": "Creates a new event scoreboard activity entry.", "operationId": "post_event_scoreboard_activity_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventScoreboardActivity2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new EventScoreboardActivity", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventScoreboardActivity" } } } } } } }, "\/api\/event\/scoreboard_activity\/{identifier}": { "get": { "tags": [ "Event \/ EventScoreboardActivity" ], "summary": "Returns a single event scoreboard activity entry.", "operationId": "get_event_scoreboard_activity_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EventScoreboardActivity", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventScoreboardActivity" } } } } } }, "put": { "tags": [ "Event \/ EventScoreboardActivity" ], "summary": "Updates an existing event scoreboard activity entry.", "operationId": "put_event_scoreboard_activity_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventScoreboardActivity2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EventScoreboardActivity", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventScoreboardActivity" } } } } } }, "delete": { "tags": [ "Event \/ EventScoreboardActivity" ], "summary": "Removes an entry from the match (soft delete); the score is recalculated.", "operationId": "delete_event_scoreboard_activity_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single EventScoreboardActivity", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventScoreboardActivity" } } } } } }, "patch": { "tags": [ "Event \/ EventScoreboardActivity" ], "summary": "Updates an existing event scoreboard activity entry.", "operationId": "patch_event_scoreboard_activity_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventScoreboardActivity2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EventScoreboardActivity", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventScoreboardActivity" } } } } } } }, "\/api\/event\/base_event\/{identifier}\/scoreboard": { "get": { "tags": [ "Event \/ EventScoreboardActivity" ], "summary": "The scoreboard of an event (state, entries, realtime topic), as in BaseEvent.scoreboard.", "description": "Recalculates it with ?recalculate=1.", "operationId": "get_event_base_event_scoreboard", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Scoreboard" } } } }, "\/api\/event\/customer\/scoreboard\/{eventIdentifier}\/activity": { "post": { "tags": [ "Event \/ EventScoreboardTrainer" ], "summary": "Add a scoreboard entry (score, card, suspension, period start\/end, ...) as trainer of the event", "operationId": "post_event_scoreboard_trainer_activity_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventScoreboardActivity2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Scoreboard of the event" } } } }, "\/api\/event\/customer\/scoreboard\/{eventIdentifier}\/activity\/{identifier}": { "delete": { "tags": [ "Event \/ EventScoreboardTrainer" ], "summary": "Remove a scoreboard entry as trainer of the event", "operationId": "delete_event_scoreboard_trainer_activity_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Scoreboard of the event" } } } }, "\/api\/event\/timing_result": { "get": { "tags": [ "Event \/ EventTimingResult" ], "summary": "Returns a list of event timing result entries.", "operationId": "get_event_timing_result_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "signUp", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "statusManual", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "gender", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "ageClass", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "rankOverall", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "rankGender", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "rankAgeClass", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "netTimeMs", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "grossTimeMs", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "calculated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EventTimingResult objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventTimingResult" } } } } } } } }, "\/api\/event\/timing_result\/{identifier}": { "get": { "tags": [ "Event \/ EventTimingResult" ], "summary": "Returns a single event timing result entry.", "operationId": "get_event_timing_result_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EventTimingResult", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingResult" } } } } } }, "put": { "tags": [ "Event \/ EventTimingResult" ], "summary": "Manual status (DNS, DNF, DSQ, ...) and note. With status_manual = false the calculated status returns.", "operationId": "put_event_timing_result_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventTimingResult2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EventTimingResult", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingResult" } } } } } }, "patch": { "tags": [ "Event \/ EventTimingResult" ], "summary": "Manual status (DNS, DNF, DSQ, ...) and note. With status_manual = false the calculated status returns.", "operationId": "patch_event_timing_result_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventTimingResult2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a EventTimingResult", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventTimingResult" } } } } } } }, "\/api\/event\/base_event\/{identifier}\/timing\/recalculate": { "post": { "tags": [ "Event \/ EventTimingResult" ], "summary": "Recalculates all results of the event from the reads.", "operationId": "post_event_base_event_timing_recalculate", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{success, results}" } } } }, "\/api\/event\/base_event\/{identifier}\/timing\/live": { "get": { "tags": [ "Event \/ EventTimingResult" ], "summary": "Live snapshot for the admin app (full names, all positions).", "operationId": "get_event_base_event_timing_live", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Live snapshot" } } } }, "\/api\/event\/base_event\/{identifier}\/timing\/course": { "put": { "tags": [ "Event \/ EventTimingResult" ], "summary": "Sets the course from a GPX document or a list of points; null removes it.", "operationId": "put_event_base_event_timing_course", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "gpx": { "type": "string" }, "points": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } } }, "type": "object" } } } }, "responses": { "200": { "description": "{timing_course}" } } }, "patch": { "tags": [ "Event \/ EventTimingResult" ], "summary": "Sets the course from a GPX document or a list of points; null removes it.", "operationId": "patch_event_base_event_timing_course", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "gpx": { "type": "string" }, "points": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } } }, "type": "object" } } } }, "responses": { "200": { "description": "{timing_course}" } } } }, "\/api\/event\/timing\/device\/config": { "get": { "tags": [ "Event \/ EventTimingDeviceApi" ], "summary": "Everything a device needs to work offline: event, timing points, participants.", "operationId": "get_event_timing_device_api_config", "parameters": [ { "name": "X-Iw-Timing-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Device configuration" } } } }, "\/api\/event\/timing\/device\/reads": { "post": { "tags": [ "Event \/ EventTimingDeviceApi" ], "summary": "Reads of the device. Without timing_point the point of the device is used.", "operationId": "post_event_timing_device_api_reads", "parameters": [ { "name": "X-Iw-Timing-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "reads": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "{results: [ReadResult], server_time_ms}" } } } }, "\/api\/event\/timing\/device\/heartbeat": { "post": { "tags": [ "Event \/ EventTimingDeviceApi" ], "summary": "Keep alive with clock sync: the server stores the offset and applies it to later reads.", "operationId": "post_event_timing_device_api_heartbeat", "parameters": [ { "name": "X-Iw-Timing-Token", "in": "header", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "device_time_ms": { "type": "integer" }, "battery_level": { "type": "integer" }, "firmware": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "{server_time_ms, clock_offset_ms}" } } } }, "\/api\/event\/public\/timing\/{eventToken}\/live": { "get": { "tags": [ "Event \/ EventTimingPublic" ], "summary": "Returns the live status.", "operationId": "get_event_timing_public_live", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Live snapshot" } } } }, "\/api\/event\/public\/timing\/{eventToken}\/results": { "get": { "tags": [ "Event \/ EventTimingPublic" ], "summary": "Returns the results.", "operationId": "get_event_timing_public_results", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{event, results}" } } } }, "\/api\/event\/customer\/timing\/sign_up": { "get": { "tags": [ "Event \/ EventTimingCustomer" ], "summary": "Own sign ups at events with bib numbers or timing.", "operationId": "get_event_timing_customer_sign_up_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "[{sign_up_id, name, bib_label, age_class, chip_code, timing_tracking_consent, event, result}]" } } } }, "\/api\/event\/customer\/timing\/sign_up\/{identifier}\/check_in": { "post": { "tags": [ "Event \/ EventTimingCustomer" ], "summary": "\"I am at the start\": a read at the START point of the event.", "operationId": "post_event_timing_customer_check_in", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "accuracy": { "type": "number" } }, "type": "object" } } } }, "responses": { "200": { "description": "{results: [ReadResult]}" } } } }, "\/api\/event\/customer\/timing\/sign_up\/{identifier}\/track_points": { "post": { "tags": [ "Event \/ EventTimingCustomer" ], "summary": "GPS points while running, only with consent.", "operationId": "post_event_timing_customer_track_points", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "points": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "{stored}" } } } }, "\/api\/event\/customer\/timing\/sign_up\/{identifier}\/consent": { "put": { "tags": [ "Event \/ EventTimingCustomer" ], "summary": "Consent to GPS live tracking. Withdrawing deletes the stored points immediately.", "operationId": "put_event_timing_customer_consent", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "timing_tracking_consent": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The customer entry of the sign up" } } }, "patch": { "tags": [ "Event \/ EventTimingCustomer" ], "summary": "Consent to GPS live tracking. Withdrawing deletes the stored points immediately.", "operationId": "patch_event_timing_customer_consent", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "timing_tracking_consent": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The customer entry of the sign up" } } } }, "\/api\/event\/base_bookable_for_self_service_scope\/{scope}": { "get": { "tags": [ "Event \/ BaseBookable" ], "summary": "Returns a list of BaseBookable objects with given self-service access scope", "operationId": "get_event_base_bookable_self_service_scope_cget", "parameters": [ { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bookableType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "slugIdentifier", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressStreetLevel", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCity", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressZip", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressCountry", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLat", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addressGeoLng", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "billingMode", "in": "query", "description": "How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows \"Nutzung erfassen\" only for usage-billed bookables. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "usageBillingInterval", "in": "query", "description": "Billing interval for BILLING_MODE_USAGE: USAGE_BILLING_INTERVAL_PER_BOOKING or USAGE_BILLING_INTERVAL_MONTHLY. Null = use setting event_real_usage_billing_mode. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxActiveBookingsPerUser", "in": "query", "description": "Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxAdvanceBookingHours", "in": "query", "description": "Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "inventoryManaged", "in": "query", "description": "Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "inventoryNumber", "in": "query", "description": "Inventory number of the item (Inventarnummer). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "scope", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of BaseBookable objects with given self-service access scope", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookable" } } } } } } } }, "\/api\/event\/base_bookable_calendar\/{identifier}\/{anonymized}": { "get": { "tags": [ "Event \/ BaseBookable" ], "summary": "Returns a calendar feed for a bookable", "operationId": "get_event_base_bookable_single_calendar", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "anonymized", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "head": { "tags": [ "Event \/ BaseBookable" ], "summary": "Returns a calendar feed for a bookable", "operationId": "head_event_base_bookable_single_calendar", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "anonymized", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_bookable_status": { "get": { "tags": [ "Event \/ BaseBookable Status" ], "summary": "This method will get all BaseBookable getBookableAvailability", "operationId": "get_event_base_bookable_status_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_event": { "get": { "tags": [ "Event \/ Event" ], "summary": "Returns a list of events", "operationId": "get_event_base_event_cget", "parameters": [ { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "ageGroup", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "processedMinAge", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "processedMaxAge", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "generateDayOfWeek", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bitmaskDaysOfWeek", "in": "query", "description": "This is a bitmask value of the days of the week the event occurs on | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bitmaskHoursStart", "in": "query", "description": "This is a bitmask value of the hours an event starts on | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "orderStringOne", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "orderStringTwo", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "orderWeekday", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "orderWeekdayOngoing", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "slugIdentifier", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "minGradeLevel", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxGradeLevel", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "highlight", "in": "query", "description": "This property is used to mark an entity as highlighted | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "trialEnabled", "in": "query", "description": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "requireAge", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "requireGradeLevel", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of events", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEvent" } } } } } } }, "post": { "tags": [ "Event \/ Event" ], "summary": "Add a new BaseEvent", "operationId": "post_event_base_event_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEvent2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseEvent", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEvent3" } } } } } } }, "\/api\/event\/base_event\/{identifier}": { "get": { "tags": [ "Event \/ Event" ], "summary": "Returns a single BaseEvent with the given id or token", "operationId": "get_event_base_event_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseEvent with the given id or token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEvent3" } } } } } }, "put": { "tags": [ "Event \/ Event" ], "summary": "Update a BaseEvent", "operationId": "put_event_base_event_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEvent2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseEvent", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEvent3" } } } } } }, "patch": { "tags": [ "Event \/ Event" ], "summary": "Update a BaseEvent", "operationId": "patch_event_base_event_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEvent2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseEvent", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEvent3" } } } } } } }, "\/api\/event\/base_event_customer": { "get": { "tags": [ "Event \/ Event" ], "summary": "This method will get all BaseEvent Objects for customer", "operationId": "get_event_base_event_cget_customer", "parameters": [ { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "ageGroup", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "processedMinAge", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "processedMaxAge", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "generateDayOfWeek", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bitmaskDaysOfWeek", "in": "query", "description": "This is a bitmask value of the days of the week the event occurs on | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bitmaskHoursStart", "in": "query", "description": "This is a bitmask value of the hours an event starts on | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "orderStringOne", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "orderStringTwo", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "orderWeekday", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "orderWeekdayOngoing", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "slugIdentifier", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "minGradeLevel", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "maxGradeLevel", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "highlight", "in": "query", "description": "This property is used to mark an entity as highlighted | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "trialEnabled", "in": "query", "description": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "requireAge", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "requireGradeLevel", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseEvent objects for customer", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEvent3" } } } } } } } }, "\/api\/event\/base_event_base_booking\/{identifier}": { "get": { "tags": [ "Event \/ Event" ], "summary": "This method will get bookings for a BaseEvent with the given id or token", "operationId": "get_event_base_event_get_bookings", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of BaseBooking objects for the given event", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking2" } } } } } } } }, "\/api\/event\/base_event_people_limit": { "get": { "tags": [ "Event \/ Event Status" ], "summary": "This method will get all BaseEvent getEventPeopleLimit", "operationId": "get_event_base_event_get_people_limit", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/public\/base_event_people_limit": { "get": { "tags": [ "Event \/ Event Status" ], "summary": "This method will get all BaseEvent freeSignUpSlots", "operationId": "get_event_base_event_get_public_people_limit", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_event_highlight": { "get": { "tags": [ "Event \/ Event" ], "summary": "Returns a single highlighted BaseEvent. If multiple highlighted events match the query, one is selected randomly. Result is cached for 10 minutes.", "operationId": "get_event_base_event_get_highlight", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a single highlighted BaseEvent", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEvent3" } } } } } } }, "\/api\/event\/base_event_booking_schedule": { "get": { "tags": [ "Event \/ Event Schedule" ], "summary": "Returns a list of BaseEventBookingSchedule", "operationId": "get_event_base_event_booking_schedule_cget", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseEventBookingSchedule", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule" } } } } } } }, "post": { "tags": [ "Event \/ Event Schedule" ], "summary": "Add a new BaseEventBookingSchedule", "operationId": "post_event_base_event_booking_schedule_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseEventBookingSchedule", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule3" } } } } } } }, "\/api\/event\/base_event_booking_schedule\/{identifier}": { "get": { "tags": [ "Event \/ Event Schedule" ], "summary": "Returns a single BaseEventBookingSchedule with the given id", "operationId": "get_event_base_event_booking_schedule_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseEventBookingSchedule with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule3" } } } } } }, "put": { "tags": [ "Event \/ Event Schedule" ], "summary": "Update a BaseEventBookingSchedule", "operationId": "put_event_base_event_booking_schedule_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseEventBookingSchedule", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule3" } } } } } }, "patch": { "tags": [ "Event \/ Event Schedule" ], "summary": "Update a BaseEventBookingSchedule", "operationId": "patch_event_base_event_booking_schedule_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseEventBookingSchedule", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule3" } } } } } } }, "\/api\/event\/base_event_invitation": { "get": { "tags": [ "Event \/ BaseEventInvitation" ], "summary": "Returns a list of BaseEventInvitation objects", "operationId": "get_event_base_event_invitation_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "read", "in": "query", "description": "Requires access right: LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseEventInvitation objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventInvitation" } } } } } } }, "post": { "tags": [ "Event \/ BaseEventInvitation" ], "summary": "Add a new BaseEventInvitation", "operationId": "post_event_base_event_invitation_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventInvitation2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseEventInvitation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventInvitation3" } } } } } } }, "\/api\/event\/base_event_invitation\/{identifier}": { "get": { "tags": [ "Event \/ BaseEventInvitation" ], "summary": "Returns a single BaseEventInvitation with the given id", "operationId": "get_event_base_event_invitation_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseEventInvitation with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventInvitation" } } } } } }, "put": { "tags": [ "Event \/ BaseEventInvitation" ], "summary": "Update a BaseEventInvitation", "operationId": "put_event_base_event_invitation_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventInvitation2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseEventInvitation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventInvitation3" } } } } } }, "delete": { "tags": [ "Event \/ BaseEventInvitation" ], "summary": "Deletes a single BaseEventInvitation", "operationId": "delete_event_base_event_invitation_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single BaseEventInvitation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventInvitation3" } } } } } }, "patch": { "tags": [ "Event \/ BaseEventInvitation" ], "summary": "Update a BaseEventInvitation", "operationId": "patch_event_base_event_invitation_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventInvitation2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseEventInvitation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventInvitation3" } } } } } } }, "\/api\/event\/multi_base_event_invitation": { "post": { "tags": [ "Event \/ BaseEventInvitation" ], "summary": "Add a new BaseEventInvitation for multiple People", "operationId": "post_event_base_event_invitation_post_multi", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventInvitation2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseEventInvitation for multiple People", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventInvitation3" } } } } } } }, "\/api\/event\/base_event_invitation_customer\/{identifier}": { "put": { "tags": [ "Event \/ BaseEventInvitation" ], "summary": "Update a BaseEventInvitation as customer", "operationId": "put_event_base_event_invitation_put_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventInvitation4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseEventInvitation as customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventInvitation" } } } } } }, "patch": { "tags": [ "Event \/ BaseEventInvitation" ], "summary": "Update a BaseEventInvitation as customer", "operationId": "patch_event_base_event_invitation_put_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventInvitation4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseEventInvitation as customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventInvitation" } } } } } } }, "\/api\/event\/base_booking": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Returns a list of BaseBooking", "operationId": "get_event_base_booking_cget", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseBooking", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking3" } } } } } } }, "post": { "tags": [ "Event \/ Booking" ], "summary": "Creates a single BaseBooking", "operationId": "post_event_base_booking_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBooking24" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single BaseBooking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking5" } } } } } } }, "\/api\/event\/base_booking\/{identifier}": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Returns a single BaseBooking", "operationId": "get_event_base_booking_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseBooking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking5" } } } } } }, "put": { "tags": [ "Event \/ Booking" ], "summary": "Updates a single BaseBooking", "operationId": "put_event_base_booking_put", "parameters": [ { "name": "suppressNotification", "in": "query", "description": "If true and this update cancels the booking (deleted=true), no automatic cancellation notification is sent for this action.", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBooking24" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single BaseBooking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking5" } } } } } }, "delete": { "tags": [ "Event \/ Booking" ], "summary": "Deletes a single BaseBooking", "operationId": "delete_event_base_booking_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single BaseBooking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking5" } } } } } }, "patch": { "tags": [ "Event \/ Booking" ], "summary": "Updates a single BaseBooking", "operationId": "patch_event_base_booking_put", "parameters": [ { "name": "suppressNotification", "in": "query", "description": "If true and this update cancels the booking (deleted=true), no automatic cancellation notification is sent for this action.", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBooking24" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single BaseBooking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking5" } } } } } } }, "\/api\/event\/base_booking_test": { "post": { "tags": [ "Event \/ Booking" ], "summary": "Test a new BaseBooking", "operationId": "post_event_base_booking_test", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Test a new BaseBooking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking2" } } } } } } }, "\/api\/event\/base_booking\/{identifier}\/adds\/attachments": { "post": { "tags": [ "Event \/ Booking" ], "summary": "Adds an uploaded Attachment to a BaseBooking (upload first via \/api\/attachments\/{companyId}\/companies)", "operationId": "post_event_base_booking_post_add_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Adds an Attachment to a BaseBooking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking6" } } } } } } }, "\/api\/event\/base_booking\/{identifier}\/removes\/attachments": { "post": { "tags": [ "Event \/ Booking" ], "summary": "Removes an Attachment from a BaseBooking (the file itself stays in the attachment list)", "operationId": "post_event_base_booking_post_remove_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Removes an Attachment from a BaseBooking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking6" } } } } } } }, "\/api\/event\/base_booking_update_multi": { "post": { "tags": [ "Event \/ Booking" ], "summary": "Updates an existing field in multiple bookings entry.", "operationId": "post_event_base_booking_update_multi", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_booking_check_overlaps": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Returns bookings that overlap the given period on the given bookables, ignoring bookings of type BLOCKING.", "description": "Used to warn the user before saving a blocking booking that would conflict with existing appointments.", "operationId": "get_event_base_booking_check_overlaps", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns overlapping bookings for a potential blocking booking", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking7" } } } } } } } }, "\/api\/event\/base_booking_calendar\/{anonymized}": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Returns a calendar feed of bookings", "operationId": "get_event_base_booking_calendar", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "anonymized", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "head": { "tags": [ "Event \/ Booking" ], "summary": "Returns a calendar feed of bookings", "operationId": "head_event_base_booking_calendar", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "anonymized", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_booking_customer": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Get all BaseBooking for a customer", "operationId": "get_event_base_booking_cget_customer", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all BaseBooking for a customer", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking8" } } } } } } } }, "\/api\/event\/base_booking_customer_calendar": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Returns the bookings of the given bookables within the given period for the booking-calendar widget.", "description": "Privacy: only non-deleted bookings are returned. A booking whose event is public returns its real name and a\nminimal event reference. Every other booking (a plain block or a non-public event) is anonymized to the name\n\"Block\" and carries no participant \/ performing-person \/ description data.", "operationId": "get_event_base_booking_customer_calendar", "parameters": [ { "name": "startTime", "in": "query", "description": "ISO8601 start of the window", "required": true, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "ISO8601 end of the window", "required": true, "schema": { "type": "string" } }, { "name": "bookableIds", "in": "query", "description": "Comma separated list of bookable ids", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_booking_customer_participant": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Get all BaseBooking for a customer that is the participant", "operationId": "get_event_base_booking_cget_customer_participant", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all BaseBooking for a customer that is the participant", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking8" } } } } } } } }, "\/api\/event\/base_booking_customer_performing": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Get all BaseBooking for a customer that is the performing person", "operationId": "get_event_base_booking_cget_customer_performing", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get all BaseBooking for a customer that is the performing person", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking8" } } } } } } } }, "\/api\/event\/base_booking_customer_waitlist_position": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Get waitlist positions for BaseBooking for a customer", "operationId": "get_event_base_booking_cget_customer_waitlist_position", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get waitlist positions for BaseBooking for a customer", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking8" } } } } } } } }, "\/api\/event\/base_booking_customer_booking_participants": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Get booking participants (signups) and waitlist positions for a customer's bookings.", "description": "Returns both booking_participants (grouped by booking ID) and waitlist_positions in a single response.", "operationId": "get_event_base_booking_cget_customer_booking_participants", "parameters": [ { "name": "person", "in": "query", "description": "Filter by person identifier", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_booking_customer\/{bookingId}": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Get a single BaseBooking for a customer", "operationId": "get_event_base_booking_get_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single BaseBooking for a customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking8" } } } } } } }, "\/api\/event\/base_booking_people_limit\/{year}\/{month}": { "get": { "tags": [ "Event \/ Booking Status" ], "summary": "This method will get all BaseBooking getEventPeopleLimit", "operationId": "get_event_base_booking_get_people_limit_calendar", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "year", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "month", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_booking_people_limit": { "get": { "tags": [ "Event \/ Booking Status" ], "summary": "This method will get all BaseBooking getEventPeopleLimit", "operationId": "get_event_base_booking_get_people_limit", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/customer\/base_booking": { "post": { "tags": [ "Event \/ Booking" ], "summary": "Creates a single BaseBooking for a BaseBookable as a customer", "operationId": "post_event_base_booking_post_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBooking24" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single BaseBooking for a BaseBookable as a customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking9" } } } } } } }, "\/api\/event\/public\/base_booking": { "post": { "tags": [ "Event \/ Booking" ], "summary": "Creates a single BaseBooking for a BaseBookable as a guest", "operationId": "post_event_base_booking_post_public", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBooking24" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single BaseBooking for a BaseBookable as a guest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking9" } } } } } } }, "\/api\/event\/public\/test_base_booking": { "post": { "tags": [ "Event \/ Booking" ], "summary": "Test adding a new BaseBooking as customer \/ public", "operationId": "post_event_base_booking_post_test_self_service", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Test adding a new BaseBooking as customer \/ public", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingTest" } } } } } } }, "\/api\/event\/public\/deleted_event_bookings": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Returns a list of public deleted BaseBooking", "operationId": "get_event_base_booking_get_deleted_event_bookings", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of public deleted BaseBooking", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking10" } } } } } } } }, "\/api\/event\/public\/self_assign_bookings_for_bookable\/{baseBookableIdentifier}": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Get all BaseBooking for a BaseBookable where performingPerson can be self-assigned", "operationId": "get_event_base_booking_cget_self_assign_bookings_for_bookable", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "baseBookableIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get all BaseBooking for a BaseBookable where performingPerson can be self-assigned", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking8" } } } } } } } }, "\/api\/event\/public\/self_assign_bookings\/{identifier}": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Returns a single BaseBooking where performingPerson can be self-assigned", "operationId": "get_event_base_booking_get_self_assign_bookings", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseBooking where performingPerson can be self-assigned", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking8" } } } } } } }, "\/api\/event\/base_booking_group": { "get": { "tags": [ "Event \/ BookingGroup" ], "summary": "Returns a list of BaseBookingGroup", "operationId": "get_event_base_booking_group_cget", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseBookingGroup", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookingGroup" } } } } } } }, "post": { "tags": [ "Event \/ BookingGroup" ], "summary": "Creates a single BaseBookingGroup", "operationId": "post_event_base_booking_group_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single BaseBookingGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingGroup3" } } } } } } }, "\/api\/event\/base_booking_group\/{identifier}": { "get": { "tags": [ "Event \/ BookingGroup" ], "summary": "Returns a single BaseBookingGroup", "operationId": "get_event_base_booking_group_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseBookingGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingGroup3" } } } } } }, "put": { "tags": [ "Event \/ BookingGroup" ], "summary": "Updates a single BaseBookingGroup", "operationId": "put_event_base_booking_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single BaseBookingGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingGroup3" } } } } } }, "delete": { "tags": [ "Event \/ BookingGroup" ], "summary": "Deletes a single BaseBookingGroup", "operationId": "delete_event_base_booking_group_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single BaseBookingGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingGroup3" } } } } } }, "patch": { "tags": [ "Event \/ BookingGroup" ], "summary": "Updates a single BaseBookingGroup", "operationId": "patch_event_base_booking_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookingGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single BaseBookingGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingGroup3" } } } } } } }, "\/api\/event\/base_booking_group\/{identifier}\/adds\/attachments": { "post": { "tags": [ "Event \/ BookingGroup" ], "summary": "Adds an uploaded Attachment to a BaseBookingGroup (upload first via \/api\/attachments\/{companyId}\/companies)", "operationId": "post_event_base_booking_group_post_add_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Adds an Attachment to a BaseBookingGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingGroup4" } } } } } } }, "\/api\/event\/base_booking_group\/{identifier}\/removes\/attachments": { "post": { "tags": [ "Event \/ BookingGroup" ], "summary": "Removes an Attachment from a BaseBookingGroup (the file itself stays in the attachment list)", "operationId": "post_event_base_booking_group_post_remove_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Removes an Attachment from a BaseBookingGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookingGroup4" } } } } } } }, "\/api\/event\/base_booking_group_check_overlaps": { "get": { "tags": [ "Event \/ BookingGroup" ], "summary": "Returns bookings that overlap the given period on the given bookables, ignoring bookings of type BLOCKING.", "description": "Used to warn the user before saving a blocking booking group that would conflict with existing appointments.\nThe group is expanded per bookable - each input booking shares the group's timespan.", "operationId": "get_event_base_booking_group_check_overlaps", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns overlapping bookings for a potential blocking booking group", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking7" } } } } } } } }, "\/api\/event\/base_event_signup": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will get all BaseEventSignUp Objects", "operationId": "get_event_base_event_signup_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseEventSignUp objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Add a new BaseEventSignUp", "operationId": "post_event_base_event_signup_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new BaseEventSignUp", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "\/api\/event\/base_event_signup\/{identifier}": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will get a single BaseEventSignUp with the given id or token", "operationId": "get_event_base_event_signup_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseEventSignUp", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } }, "put": { "tags": [ "Event \/ EventSignUp" ], "summary": "Update a BaseEventSignUp", "operationId": "put_event_base_event_signup_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a BaseEventSignUp", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } }, "delete": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will delete a single BaseEventSignUp with the given id or token", "operationId": "delete_event_base_event_signup_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single BaseEventSignUp", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } }, "patch": { "tags": [ "Event \/ EventSignUp" ], "summary": "Update a BaseEventSignUp", "operationId": "patch_event_base_event_signup_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a BaseEventSignUp", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "\/api\/event\/base_event_signup\/membership\/assign": { "post": { "tags": [ "Event \/ SignUpMembership" ], "summary": "Assign memberships\/subscriptions to event sign-ups.", "operationId": "post_event_base_event_signup_membership_assign", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/EventSignUpMembershipAssignType" } }, "type": "object" } } } }, "responses": { "200": { "description": "Assignment results" } } } }, "\/api\/event\/customer\/base_event_signup": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will get all BaseEventSignUp Objects for customer", "operationId": "get_event_base_event_signup_cget_customer", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseEventSignUp objects for customer", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Add a new BaseEventSignUp as customer", "operationId": "post_event_base_event_signup_post_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new BaseEventSignUp as customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "\/api\/event\/customer\/base_event_signup_group": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Sign up several persons of the selected company together (e.g. a family for a run)", "description": "All persons are signed up or none: every entry runs the same checks as a single\ncustomer sign-up (access, timing, required fields, price incl. member prices) and the\nevent must have a free place for each of them - a group never goes onto the wait list.\nWith direct billing the whole group gets one invoice and one payment.\nBody: the shared sign-up fields plus `sign_ups`, one entry per person with `person`,\n`product` (the selected price) and the per-person fields of the event (birthday,\nallergies, `media_questionnaire_answer`, `invoice_products`, ...).\nOnly while the setting `event_sign_up_group_enabled` is on (iw error 403 otherwise).", "operationId": "post_event_base_event_signup_group_post_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventSignUp3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Sign up several persons of the selected company together", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup" } } } } } } }, "\/api\/event\/public\/base_event_signup_group": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Sign up several persons together as a guest (e.g. a family for a public run)", "description": "Like the customer group sign-up, but without a login: every entry carries the\nparticipant's own data (`first_name`, `last_name`, birthday, ... and the\nper-person fields of the event); contact, address and payment data are shared\nand sent once. Only prices without access conditions can be chosen. All or none\nare signed up, never onto the wait list; with direct billing the group pays one invoice.\nOnly while the setting `event_sign_up_group_enabled` is on (iw error 403 otherwise).", "operationId": "post_event_base_event_signup_group_post_public", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventSignUp4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Sign up several persons together as a guest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup" } } } } } } }, "\/api\/event\/customer\/base_event_signup\/event\/{eventIdentifier}": { "delete": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will delete a single BaseEventSignUp for the person in a event", "operationId": "delete_event_base_event_signup_delete_customer_event", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single BaseEventSignUp for the person in a event", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "\/api\/event\/customer\/base_event_signup\/booking\/{bookingIdentifier}": { "delete": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will delete a single BaseEventSignUp for the person in a booking", "operationId": "delete_event_base_event_signup_delete_customer_booking", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookingIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a single BaseEventSignUp for the person in a booking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "\/api\/event\/public\/base_event_signup": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Add a new BaseEventSignUp for event or booking as a guest", "operationId": "post_event_base_event_signup_post_public", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventSignUp4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseEventSignUp for event or booking as a guest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp" } } } } } } }, "\/api\/event\/public\/unified_event_details\/{identifier}": { "get": { "tags": [ "Event \/ Public" ], "summary": "Get event + future bookings + test adding a new BaseEventSignUp as customer \/ public", "operationId": "get_event_base_event_signup_get_unified_event_details", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get event + future bookings + test adding a new BaseEventSignUp as customer \/ public", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEvent25" } } } } } } }, "\/api\/event\/public\/test_base_event_signup": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Test adding a new BaseEventSignUp as customer \/ public", "operationId": "post_event_base_event_signup_post_test_self_service", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventSignUp3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Test adding a new BaseEventSignUp as customer \/ public", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUpTest" } } } } } } }, "\/api\/event\/admin\/test_base_event_signup": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Test adding a new BaseEventSignUp for the person from the admin ui", "operationId": "post_event_base_event_signup_post_test_admin", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventSignUp3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Test adding a new BaseEventSignUp for the person from the admin ui", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/event\/base_event_signup\/{identifier}\/rebook": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Rebook a BaseEventSignUp from one event to another.", "description": "This will archive the original signup and create a new one in the target event with the same participant data.", "operationId": "post_event_base_event_signup_rebook", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Rebook a BaseEventSignUp from one event to another", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "\/api\/event\/base_event_signup\/{identifier}\/copy": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Copy a BaseEventSignUp to another event\/booking. The original signup is kept intact.", "operationId": "post_event_base_event_signup_copy", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Copy a BaseEventSignUp to another event\/booking", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "\/api\/event\/base_event\/{identifier}\/copy_main_signups_to_bookings": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Copy all current main-event sign-ups of a BaseEvent into one or more of its bookings.", "description": "Mirrors the behavior of BaseEventCopySignUpToBookingCommand, but runs on demand for\nuser-selected bookings and does not touch the copied_to_booking_until markers used\nby the automatic generation.", "operationId": "post_event_base_event_signup_copy_main_to_bookings", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Copy all main-event sign-ups into the given bookings", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventSignUpCopyToBookingsResult" } } } } } } }, "\/api\/event\/public\/base_event_signup\/wait_list_confirm\/{token}": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Confirm a waitlist promotion via token (public, no auth required)", "operationId": "post_event_base_event_signup_wait_list_confirm", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/base_event_signup\/{identifier}\/request_payment": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Trigger the online payment for a sign up that has no invoice yet", "description": "Writes the missing (proforma) invoice, mails the payment link to the\nregistered person and starts the payment deadline. The same work the\nscheduled inwendo:billing:direct-billing-request-payment does, for one\nsign up and without waiting for the next run.", "operationId": "post_event_base_event_signup_request_payment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the created invoice, the payment link and the deadline" } } } }, "\/api\/event\/base_event_signup\/{identifier}\/wait_list_confirm": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Admin: Confirm a waitlist promotion on behalf of a person", "operationId": "post_event_base_event_signup_wait_list_admin_confirm", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/customer\/base_event_signup\/{identifier}\/wait_list_confirm": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Customer: confirm the own (or a household member's) wait list promotion", "description": "The logged-in counterpart of the public token link: the sign-up must belong to the\nselected company and one of its persons, a confirmation must be pending and the\ndeadline must not have passed.", "operationId": "post_event_base_event_signup_customer_wait_list_confirm", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Customer: confirm a wait list promotion", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } }, "\/api\/event\/trial_policy": { "get": { "tags": [ "Event \/ TrialPolicy (Schnupper-Regel)" ], "summary": "Returns a list of trial policy entries.", "operationId": "get_event_trial_policy_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "scope", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "audience", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "capacityMode", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "priceMode", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of TrialPolicy objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TrialPolicy" } } } } } } }, "post": { "tags": [ "Event \/ TrialPolicy (Schnupper-Regel)" ], "summary": "Creates a new trial policy entry.", "operationId": "post_event_trial_policy_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrialPolicy2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new TrialPolicy", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrialPolicy" } } } } } } }, "\/api\/event\/trial_policy\/{identifier}": { "get": { "tags": [ "Event \/ TrialPolicy (Schnupper-Regel)" ], "summary": "Returns a single trial policy entry.", "operationId": "get_event_trial_policy_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single TrialPolicy", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrialPolicy" } } } } } }, "put": { "tags": [ "Event \/ TrialPolicy (Schnupper-Regel)" ], "summary": "Updates an existing trial policy entry.", "operationId": "put_event_trial_policy_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrialPolicy2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a TrialPolicy", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrialPolicy" } } } } } }, "delete": { "tags": [ "Event \/ TrialPolicy (Schnupper-Regel)" ], "summary": "Archive a TrialPolicy (soft delete); events and categories that use it offer no trials until they get another rule", "operationId": "delete_event_trial_policy_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Archive a TrialPolicy", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrialPolicy" } } } } } }, "patch": { "tags": [ "Event \/ TrialPolicy (Schnupper-Regel)" ], "summary": "Updates an existing trial policy entry.", "operationId": "patch_event_trial_policy_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TrialPolicy2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a TrialPolicy", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TrialPolicy" } } } } } } }, "\/api\/event\/customer\/trial\/base_event": { "get": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Events the selected person can try out, each with the trial check (remaining dates, reason\nwhen it is not bookable right now). Query: person (a person of the selected company, default the user).", "operationId": "get_event_trial_customer_base_event_cget", "parameters": [ { "name": "person", "in": "query", "description": "Person of the selected company", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of {event, allowed, reason, error_code, trial_max, trial_used, trial_remaining, trial_status}" } } } }, "\/api\/event\/customer\/trial\/base_event\/{eventIdentifier}": { "get": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Trial check for one event and the dates the selected person can book as trial dates.", "operationId": "get_event_trial_customer_base_event_check", "parameters": [ { "name": "person", "in": "query", "description": "Person of the selected company", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{allowed, reason, error_code, trial_max, trial_used, trial_remaining, trial_status, dates: [{id, name, start_time, end_time}]}" } } } }, "\/api\/event\/customer\/trial\/base_event_signup": { "post": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Book a trial date for a person of the selected company. Body: data.baseBooking; query or\ndata.person (default the user).", "operationId": "post_event_trial_customer_base_event_signup_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "baseBooking": { "type": "integer" }, "person": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The trial date sign-up", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp" } } } } } } }, "\/api\/event\/customer\/trial_pass": { "get": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Trial passes of the persons of the selected company with their trial dates - for \"noch 2 von 3\"\nand the card \"Weiter dabei sein?\" after the last trial date.", "operationId": "get_event_trial_customer_trial_pass_cget", "parameters": [ { "name": "person", "in": "query", "description": "Only this person of the selected company", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of {pass, event, sign_ups, hold}" } } } }, "\/api\/event\/public\/trial\/base_event\/{eventIdentifier}": { "get": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Public trial page of an event: the event (by its token, or by id when it is public), whether it can\nbe tried out through the public link and the dates with room for a trial person.", "operationId": "get_event_trial_public_base_event_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{event, allowed, reason, error_code, trial_max, dates: [{id, name, start_time, end_time}]}" } } } }, "\/api\/event\/public\/trial\/base_event_signup\/{eventIdentifier}": { "post": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Request a trial date through the public link. Body: data.baseBooking, firstName, lastName, birthday\n(YYYY-MM-DD), mainEmail (the parents'), mainPhone (optional), confirmedPrivacy (must be true).", "description": "Nothing is booked yet: the parents get a confirmation link by mail (and, when the child is\nalready known, the household's app users by push); the date is booked when they confirm.\nThe answer does not tell whether the person is known.", "operationId": "post_event_trial_public_base_event_signup_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "baseBooking": { "type": "integer" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "birthday": { "type": "string" }, "mainEmail": { "type": "string" }, "mainPhone": { "type": "string" }, "confirmedPrivacy": { "type": "boolean" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "{status: 'pending', main_email, expires_at}" } } } }, "\/api\/event\/public\/trial\/request\/{token}": { "get": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "A public trial request by the token of its confirmation link: course, date, the child's name\nand whether it is still open, confirmed or expired.", "operationId": "get_event_trial_public_request_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{status, expired, expires_at, first_name, last_name, course_name, start_time, end_time}" } } } }, "\/api\/event\/public\/trial\/request\/{token}\/confirm": { "post": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Confirm a public trial request: the date is booked now (all checks run again) and the booking\nmail is sent. Confirming twice returns the same sign-up; an expired link is refused with 1581.", "operationId": "post_event_trial_public_request_confirm", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The trial date sign-up", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp" } } } } } } }, "\/api\/event\/trial\/base_event\/{eventIdentifier}\/public_link": { "get": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Link of the public trial page of an event, and whether its rule allows the public channel.", "operationId": "get_event_trial_base_event_public_link", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{link, allowed, reason}" } } } }, "\/api\/event\/trainer\/trial\/base_event_signup": { "post": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Trainer of a date adds a trial person: data.baseBooking plus either data.person (a known\nperson) or firstName, lastName, birthday, mainEmail, mainPhone (found by name and birthday,\nelse created in a new household).", "operationId": "post_event_trial_trainer_base_event_signup_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "baseBooking": { "type": "integer" }, "person": { "type": "integer" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "birthday": { "type": "string" }, "mainEmail": { "type": "string" }, "mainPhone": { "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The trial date sign-up", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp" } } } } } } }, "\/api\/event\/trial\/base_event\/{eventIdentifier}\/check": { "get": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Trial check for one event and a person, with the dates the person can book as trial dates.", "operationId": "get_event_trial_base_event_check", "parameters": [ { "name": "person", "in": "query", "description": "CRMPerson", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{allowed, reason, error_code, trial_max, trial_used, trial_remaining, trial_status, dates}" } } } }, "\/api\/event\/trial\/base_event_signup": { "post": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "The office books a trial date for a person. Body: data.baseBooking, data.person.", "operationId": "post_event_trial_base_event_signup_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "baseBooking": { "type": "integer" }, "person": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The trial date sign-up", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp7" } } } } } } }, "\/api\/event\/trial_pass": { "get": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Trial passes (Schnupper-Kontingente) with their trial dates. Filters: person, baseEvent,\nunifiedCategory, trialPolicy, trialStatus.", "operationId": "get_event_trial_pass_cget", "parameters": [ { "name": "person", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "baseEvent", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "unifiedCategory", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "trialPolicy", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "trialStatus", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of {pass, event, sign_ups}" } } } }, "\/api\/event\/trial_pass\/{identifier}\/{passAction}": { "post": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Office action on a trial pass: convert (course place \/ membership arranged elsewhere),\ncancel (end the trial, no further dates) or reset (a fresh pass: dates and follow-up start over).", "operationId": "post_event_trial_pass_action", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "passAction", "in": "path", "required": true, "schema": { "type": "string", "pattern": "convert|cancel|reset", "enum": [ "convert", "cancel", "reset" ] } } ], "responses": { "200": { "description": "{pass, event, sign_ups}" } } } }, "\/api\/event\/trial_hold": { "get": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Course places held for trial persons (Schnupper-Reservierungen) with the trial dates of their\npass, for the participant list of a course and the office. Filters: status (default: open ones\n- held, pending, secured; \"all\" for every state), baseEvent, person, pass.", "operationId": "get_event_trial_hold_cget", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "person", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "pass", "in": "query", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of {hold, person, sign_ups, dates: [{sign_up_id, booking_id, start_time, end_time, deleted, present, trial_session_number, trial_session_max}]}" } } } }, "\/api\/event\/trial_hold\/{identifier}\/{holdAction}": { "post": { "tags": [ "Event \/ Trial (Schnuppern)" ], "summary": "Office action on a held course place: secure (no deadline), convert (regular sign-up with the\nnormal confirmation mail), extend (data.days or query days, default 7) or release (the place\nis free again, the wait list moves up).", "operationId": "post_event_trial_hold_action", "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "holdAction", "in": "path", "required": true, "schema": { "type": "string", "pattern": "secure|convert|extend|release", "enum": [ "secure", "convert", "extend", "release" ] } } ], "responses": { "200": { "description": "{hold, person, sign_ups}" } } } }, "\/api\/event\/age_check": { "get": { "tags": [ "Event \/ Age check" ], "summary": "Course sign-ups by age status, with the age and the limits. Filters: status (comma list,\ndefault: in_tolerance, too_old, too_young; \"all\" for every checked sign-up), baseEvent.", "operationId": "get_event_age_check_cget", "parameters": [ { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of {sign_up_id, status, months_beyond, changed_at, notified_at, person_id, first_name, last_name, birthday, age_months, event_id, event_name, min_months, max_months, tolerance_months}" } } } }, "\/api\/event\/trainer_event\/base_event_signup\/{eventIdentifier}": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will get all BaseEventSignUp Objects for trainer", "operationId": "get_event_base_event_signup_cget_trainer_event", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of BaseEventSignUp objects for trainer", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } } }, "\/api\/event\/trainer_event\/bookings_with_base_event_signup\/{eventIdentifier}": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will get all BaseEventSignUp Objects for trainer with the eventIdentifier and multiple bookings", "operationId": "get_event_base_event_signup_multiple_bookings_cget_trainer_event", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/trainer_booking\/base_event_signup\/{bookingIdentifier}": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will get all BaseEventSignUp Objects for trainer", "operationId": "get_event_base_event_signup_cget_trainer_booking", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookingIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of BaseEventSignUp objects for trainer by booking", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } } } } } } } }, "\/api\/event\/trainer_booking\/base_event_signup_with_next\/{bookingIdentifier}": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "Get participant list for a booking with next booking info per participant (same day).", "description": "Requires trainerCanViewParticipants AND trainerCanViewNextBooking to be enabled on the event data type.", "operationId": "get_event_base_event_signup_cget_trainer_booking_with_next", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookingIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/trainer_actions\/base_event_signup\/toggle\/{signUpIdentifier}": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will toggle confirmed on BaseEventSignUp Objects for trainer", "operationId": "get_event_base_event_signup_trainer_toggle_confirmed", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "signUpIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/trainer_actions\/base_event_signup\/vaccinated\/{signUpIdentifier}": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will toggle the vaccinated status on BaseEventSignUp Objects for trainer", "operationId": "get_event_base_event_signup_trainer_toggle_vaccinated", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "signUpIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/trainer_actions\/base_event_signup\/recovered\/{signUpIdentifier}": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will toggle the vaccinated status on BaseEventSignUp Objects for trainer", "operationId": "get_event_base_event_signup_trainer_toggle_recovered", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "signUpIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/trainer_actions\/base_event_signup\/update\/{signUpIdentifier}": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will update a single field on BaseEventSignUp Objects by trainer", "operationId": "post_event_base_event_signup_trainer_update", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "signUpIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/trainer_actions\/base_event_signup\/delete_for_event\/{eventIdentifier}": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Delete a participant from an entire event (main sign-up + cascades to all future bookings)", "operationId": "post_event_base_event_signup_trainer_delete_for_event", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/trainer_actions\/base_booking\/cancel\/{bookingIdentifier}": { "post": { "tags": [ "Event \/ Booking" ], "summary": "Cancel a booking by trainer (sets deleted=true with INSTRUCTOR_CANCELLED reason)", "operationId": "post_event_base_booking_trainer_cancel", "parameters": [ { "name": "suppressNotification", "in": "query", "description": "If true, no automatic cancellation notification is sent for this cancellation.", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookingIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/trainer_substitution\/summary": { "get": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Summary for the home widget and the menu badge: how many open appointments the person may\ntake over, the next ones, and the own upcoming substitutions.", "operationId": "get_event_trainer_substitution_summary", "parameters": [ { "name": "limit", "in": "query", "description": "Entries per list (default 3)", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "enabled, in_pool, available_count, available (first entries), mine_upcoming_count, mine_upcoming (first entries)" } } } }, "\/api\/event\/trainer_substitution\/available": { "get": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Open appointments the logged-in trainer may take over now, by start.", "operationId": "get_event_trainer_substitution_available", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "event", "in": "query", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of substitutions the person may take over" } } } }, "\/api\/event\/trainer_substitution\/mine": { "get": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Requested and taken over by the logged-in trainer.", "operationId": "get_event_trainer_substitution_mine", "parameters": [ { "name": "past", "in": "query", "description": "true = past ones, newest first", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Own substitutions" } } } }, "\/api\/event\/trainer_substitution\/claim_multiple": { "post": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Take several appointments over at once (e.g. all open dates of one course). Each one is\nclaimed on its own; the result lists success or the reasons per id.", "operationId": "post_event_trainer_substitution_claim_multiple", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "ids": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Per id: ok, state, reasons" } } } }, "\/api\/event\/trainer_substitution\/released": { "get": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Own appointments the logged-in trainer released and that are still searching.", "operationId": "get_event_trainer_substitution_released", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Own open releases" } } } }, "\/api\/event\/trainer_substitution\/release_check\/{bookingId}": { "get": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Whether the logged-in trainer may release this own appointment for a substitute (\"ich kann\nnicht\"), or take an earlier release back.", "operationId": "get_event_trainer_substitution_release_check", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "allowed, reasons, slot, deadline_hours and the own open release (substitution) if any" } } } }, "\/api\/event\/trainer_substitution\/release\/{bookingId}": { "post": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Release an own appointment for a substitute: the trainer is taken out of it and it is\noffered to the other trainers. Only for event types that allow it.", "operationId": "post_event_trainer_substitution_release", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "note": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The opened substitution" } } } }, "\/api\/event\/trainer_substitution\/{id}": { "get": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Returns a single event trainer substitution entry.", "operationId": "get_event_trainer_substitution_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One substitution with can_claim \/ reasons for the logged-in trainer" } } } }, "\/api\/event\/trainer_substitution\/{id}\/test": { "post": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Whether the logged-in trainer may take the substitution over, and why not. Changes nothing.", "operationId": "post_event_trainer_substitution_test", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "eligible and reason codes" } } } }, "\/api\/event\/trainer_substitution\/{id}\/claim": { "post": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Take the appointment over (DIRECT) or ask the office for it (APPROVAL). 400 with reason\ncodes when the person may not, 409 when somebody else was faster.", "operationId": "post_event_trainer_substitution_claim", "parameters": [ { "name": "lock_version", "in": "query", "description": "lock_version of the displayed substitution", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The substitution after the claim" } } } }, "\/api\/event\/trainer_substitution\/{id}\/take_back": { "post": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Take an own release back while nobody has requested or taken the appointment.", "operationId": "post_event_trainer_substitution_take_back", "parameters": [ { "name": "lock_version", "in": "query", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The closed substitution" } } } }, "\/api\/event\/trainer_substitution\/{id}\/withdraw": { "post": { "tags": [ "Event \/ Trainer substitution" ], "summary": "Step back from a request, or from a taken over appointment before the deadline.", "operationId": "post_event_trainer_substitution_withdraw", "parameters": [ { "name": "lock_version", "in": "query", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The substitution after stepping back" } } } }, "\/api\/event\/booking_substitution_log": { "get": { "tags": [ "Event \/ Booking substitution" ], "summary": "The log: who did what, when and through which channel.", "operationId": "get_event_booking_substitution_log_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "action", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "substitution", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "booking", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "actorPerson", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "fromPerson", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "toPerson", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "slot", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EventBookingSubstitutionLog objects, newest first", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventBookingSubstitutionLog" } } } } } } } }, "\/api\/event\/booking_substitution": { "get": { "tags": [ "Event \/ Booking substitution" ], "summary": "All substitutions; default order by appointment start.", "operationId": "get_event_booking_substitution_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reason", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "slot", "in": "query", "description": "1 = main trainer (performingPerson), 2 = secondary ... 5 = fifth. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "booking", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "originalPerson", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "candidatePerson", "in": "query", "description": "Who requested or took the slot, or whom the office assigned. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bookingStart", "in": "query", "description": "Copy of the appointment start: list ordering and filters without a join, and the history stays readable after the appointment is gone. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "filledVia", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "qualificationSource", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sourceTicket", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sourceNonWorkTimeRequest", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EventBookingSubstitution objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventBookingSubstitution" } } } } } } }, "post": { "tags": [ "Event \/ Booking substitution" ], "summary": "Look for a substitute for one slot of an appointment. A person still in the slot is\ntaken out and becomes the original trainer.", "operationId": "post_event_booking_substitution_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "booking": { "type": "integer" }, "slot": { "type": "integer" }, "note": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The opened substitution", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventBookingSubstitution" } } } } } } }, "\/api\/event\/booking_substitution\/{id}": { "get": { "tags": [ "Event \/ Booking substitution" ], "summary": "Returns a single event booking substitution entry.", "operationId": "get_event_booking_substitution_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EventBookingSubstitution", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventBookingSubstitution" } } } } } } }, "\/api\/event\/booking_substitution\/{id}\/candidates": { "get": { "tags": [ "Event \/ Booking substitution" ], "summary": "Every pool member with the reasons that would block them, eligible ones first. The office\nmay assign people with reasons, too, with a note.", "operationId": "get_event_booking_substitution_candidates", "parameters": [ { "name": "onlyEligible", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of {person, eligible, reasons}" } } } }, "\/api\/event\/booking_substitution\/{id}\/test_person": { "get": { "tags": [ "Event \/ Booking substitution" ], "summary": "Eligibility of one person (e.g. before assigning somebody outside the pool).", "operationId": "get_event_booking_substitution_test_person", "parameters": [ { "name": "person", "in": "query", "required": true, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "eligible and reason codes" } } } }, "\/api\/event\/booking_substitution\/{id}\/{action}": { "put": { "tags": [ "Event \/ Booking substitution" ], "summary": "approve, decline (note), assign (person, note), cancel (note), reopen (note), notify (push to the matching trainers again).", "operationId": "put_event_booking_substitution_action", "parameters": [ { "name": "lock_version", "in": "query", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "person": { "type": "integer" }, "note": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The substitution after the action", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventBookingSubstitution" } } } } } }, "patch": { "tags": [ "Event \/ Booking substitution" ], "summary": "approve, decline (note), assign (person, note), cancel (note), reopen (note), notify (push to the matching trainers again).", "operationId": "patch_event_booking_substitution_action", "parameters": [ { "name": "lock_version", "in": "query", "required": false, "schema": { "type": "integer" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "person": { "type": "integer" }, "note": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The substitution after the action", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventBookingSubstitution" } } } } } } }, "\/api\/event\/inventory_loan_stock": { "get": { "tags": [ "Event \/ Inventory loan" ], "summary": "Every inventory item with stock, lent, overdue and free pieces right now.", "operationId": "get_event_inventory_loan_stock", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "List of {bookable, quantity, lent, overdue, available_now, deposit}" } } } }, "\/api\/event\/inventory_loan_availability\/{bookableId}": { "get": { "tags": [ "Event \/ Inventory loan" ], "summary": "Free pieces of one item between start and end (bookings and loans counted).", "operationId": "get_event_inventory_loan_availability", "parameters": [ { "name": "start", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "end", "in": "query", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookableId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "{quantity, used, available}" } } } }, "\/api\/event\/inventory_loan": { "get": { "tags": [ "Event \/ Inventory loan" ], "summary": "All loans; default order: due date ascending (state=RETURNED: latest return first). overdue=1 (or state=OVERDUE) lists only lent loans\npast their due date.", "operationId": "get_event_inventory_loan_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bookable", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "booking", "in": "query", "description": "The booking the item was reserved with (null only once the booking is deleted). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "depositState", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "issuedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "dueAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "returnedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of EventInventoryLoan objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventInventoryLoan" } } } } } } }, "post": { "tags": [ "Event \/ Inventory loan" ], "summary": "Hand the item of a booking (Termin) over; item and borrower come from the booking.", "description": "Without dueAt the loan runs until the end of the booking. The deposit defaults to the\ndeposit of the item times the quantity. force=true skips the stock check.", "operationId": "post_event_inventory_loan_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "required": [ "booking" ], "properties": { "booking": { "type": "integer" }, "quantity": { "type": "integer" }, "due_at": { "type": "string" }, "deposit_amount": { "type": "number" }, "condition": { "type": "string" }, "note": { "type": "string" }, "force": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The new loan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventInventoryLoan" } } } } } } }, "\/api\/event\/inventory_loan\/{id}": { "get": { "tags": [ "Event \/ Inventory loan" ], "summary": "Returns a single event inventory loan entry.", "operationId": "get_event_inventory_loan_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single EventInventoryLoan", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventInventoryLoan" } } } } } } }, "\/api\/event\/inventory_loan\/{id}\/{action}": { "put": { "tags": [ "Event \/ Inventory loan" ], "summary": "return (condition, retained_amount = kept part of the deposit, note, returned_at),\nextend (due_at, force).", "operationId": "put_event_inventory_loan_action", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "condition": { "type": "string" }, "retained_amount": { "type": "number" }, "note": { "type": "string" }, "returned_at": { "type": "string" }, "due_at": { "type": "string" }, "force": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The loan after the action", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventInventoryLoan" } } } } } }, "patch": { "tags": [ "Event \/ Inventory loan" ], "summary": "return (condition, retained_amount = kept part of the deposit, note, returned_at),\nextend (due_at, force).", "operationId": "patch_event_inventory_loan_action", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "action", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "condition": { "type": "string" }, "retained_amount": { "type": "number" }, "note": { "type": "string" }, "returned_at": { "type": "string" }, "due_at": { "type": "string" }, "force": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "The loan after the action", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/EventInventoryLoan" } } } } } } }, "\/api\/event\/customer\/inventory_loan": { "get": { "tags": [ "Event \/ Inventory loan" ], "summary": "Own loans (all persons of the selected company); onlyLent=1 leaves out returned ones.", "operationId": "get_event_inventory_loan_customer_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "bookable", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "booking", "in": "query", "description": "The booking the item was reserved with (null only once the booking is deleted). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "depositState", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "issuedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "dueAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "returnedAt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the own EventInventoryLoan objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EventInventoryLoan2" } } } } } } } }, "\/api\/event\/self_service\/own_availability": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Lists the own availabilities of the logged in person.", "operationId": "get_event_base_booking_own_availability_cget", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Lists the own availabilities of the logged in person", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking11" } } } } } } }, "post": { "tags": [ "Event \/ Booking" ], "summary": "Creates an availability for the logged in person.", "operationId": "post_event_base_booking_own_availability_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBooking24" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates an availability for the logged in person", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking11" } } } } } } }, "\/api\/event\/self_service\/own_availability\/{identifier}": { "put": { "tags": [ "Event \/ Booking" ], "summary": "Updates an availability of the logged in person.", "operationId": "put_event_base_booking_own_availability_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBooking24" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates an availability of the logged in person", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking11" } } } } } }, "delete": { "tags": [ "Event \/ Booking" ], "summary": "Cancels an availability of the logged in person. Bookings that already picked the availability\nkeep their trainer - the availability is only the offer, not the appointment itself.", "operationId": "delete_event_base_booking_own_availability_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cancels an availability of the logged in person", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking11" } } } } } }, "patch": { "tags": [ "Event \/ Booking" ], "summary": "Updates an availability of the logged in person.", "operationId": "patch_event_base_booking_own_availability_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBooking24" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates an availability of the logged in person", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBooking11" } } } } } } }, "\/api\/event\/self_service\/availability_calendar": { "get": { "tags": [ "Event \/ Booking" ], "summary": "Calendar of all availabilities, gated by the visibility setting\nevent_trainer_availability_visibility_type.", "operationId": "get_event_base_booking_availability_calendar", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Calendar of all visible availabilities", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking11" } } } } } } } }, "\/api\/event\/self_service\/availability_options": { "get": { "tags": [ "Event \/ Booking" ], "summary": "The availabilities that can be picked as the trainer of a self service object booking for the\ngiven period. Availabilities whose trainer is already booked in that period are left out.", "operationId": "get_event_base_booking_availability_options", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "baseLocation", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable---secondaryBaseBookable", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "color", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "billed", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "waiting", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "boolean" } }, { "name": "bookingType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "contentType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "bookingStatus", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_publicDeleted", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "addonData_addressAutoCompleteType", "in": "query", "description": "Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "name": "eventType", "in": "query", "description": "denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Selectable trainer availabilities for a booking period", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking11" } } } } } } } }, "\/api\/event\/self_service\/booking_content_types": { "get": { "tags": [ "Event \/ Booking" ], "summary": "The content types a self service booking may be created with. Returns an empty list for every\ninstallation that did not flag any content type, which is what keeps the existing self service\nbooking screens unchanged.", "operationId": "get_event_base_booking_self_service_content_types", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shortName", "in": "query", "description": "Kurzname for compact UI labels (e.g. calendars, badges). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "appointment", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "availability", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "color", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "selfServiceSelectable", "in": "query", "description": "Whether this content type may be picked by a customer \/ trainer in the self service portal. Off by default so existing installations keep the current behaviour. | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "trainerAvailabilityMode", "in": "query", "description": "Controls whether a self service booking of this content type also picks the availability of a trainer: NONE (default), OPTIONAL or REQUIRED. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Content types selectable in the self service booking", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BookingContentType" } } } } } } } }, "\/api\/event\/trainer_event\/base_event_signup_scan\/{eventIdentifier}\/{personIdentifier}": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will add a new BaseEventSignUp for the event by the trainer", "operationId": "get_event_base_event_signup_scan_trainer_event", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "eventIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "personIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/trainer_booking\/base_event_signup_scan\/{bookingIdentifier}\/{personIdentifier}": { "get": { "tags": [ "Event \/ EventSignUp" ], "summary": "This method will add a new BaseEventSignUp for the booking by the trainer", "operationId": "get_event_base_event_signup_scan_trainer_booking", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "bookingIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "personIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/trainer\/test_base_event_signup": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Test adding a new BaseEventSignUp as trainer", "operationId": "post_event_base_event_signup_post_test_trainer_service", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventSignUp3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Test adding a new BaseEventSignUp as trainer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUpTrainerTest" } } } } } } }, "\/api\/event\/trainer\/base_event_signup": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Add a new BaseEventSignUp for event or booking as a trainer. Only possible if event billing not required.", "operationId": "post_event_base_event_signup_post_trainer_service", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseEventSignUp4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseEventSignUp for event or booking as a trainer. Only possible if event billing not required.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventSignUp" } } } } } } }, "\/api\/event\/trainer\/mass_notification": { "post": { "tags": [ "Event \/ EventSignUp" ], "summary": "Add a new MassUserNotification for the event signups in referenceIds", "operationId": "post_event_base_event_signup_trainer_notification", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MassUserNotification" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MassUserNotification for the event signups in referenceIds", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MassUserNotification2" } } } } } } }, "\/api\/event\/signup_distribution\/run": { "post": { "tags": [ "Event \/ SignupDistribution" ], "summary": "Run distribution algorithm for a media questionnaire's event selections.", "description": "Returns results grouped by field\/time slot.", "operationId": "post_event_signup_distribution_run", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/signup_distribution\/update": { "post": { "tags": [ "Event \/ SignupDistribution" ], "summary": "Update assignments manually (re-assign children to different events).", "description": "Accepts grouped fields format: {data: {fields: {fieldLabel: {assignments: [...]}}}}", "operationId": "post_event_signup_distribution_update", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/signup_distribution\/export": { "post": { "tags": [ "Event \/ SignupDistribution" ], "summary": "Export distribution assignments as CSV compatible with ImportSchoolLinkEventParticipantDataHandler.", "description": "Accepts either grouped format {data: {fields: {...}}} or flat {data: {assignments: [...]}}.", "operationId": "post_event_signup_distribution_export", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/signup_distribution\/execute": { "post": { "tags": [ "Event \/ SignupDistribution" ], "summary": "Directly create BaseEventSignUp records from distribution assignments.", "description": "Accepts either grouped format {data: {fields: {...}}} or flat {data: {assignments: [...]}}.", "operationId": "post_event_signup_distribution_execute", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/{identifier}\/send_questionnaire": { "post": { "tags": [ "Event \/ SignupQuestionnaireSend" ], "summary": "Send a MediaQuestionnaire to the signups of an event.", "description": "Creates a MassUserNotification (referenceClassName=BaseEventSignUp,\nreferenceIds=[signup ids], createQuestionnaireDraft=true) and schedules\nthe processing cron. The mail body defaults to a sensible invitation text\nthat renders the public fill link when no custom text\/template is supplied\n(see NotificationHelper default-body fallback).\n\nRequest body (JSON, wrapped in a \"data\" key as per the form block prefix):\n - questionnaire: id of the MediaQuestionnaire (required)\n - excludeWaiting: bool, default true\n - onlyConfirmed: bool, default false\n - sendMail: bool, default true\n - text: string, optional custom subject\n - longText: string, optional custom body", "operationId": "post_event_signup_questionnaire_send", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/event\/event_type": { "get": { "tags": [ "Event \/ EventType" ], "summary": "This method will get all BaseEventDataType Objects", "operationId": "get_event_data_type_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseEventDataType objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventDataType" } } } } } } }, "post": { "tags": [ "Event \/ EventType" ], "summary": "Add a new BaseEventDataType", "operationId": "post_event_data_type_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new BaseEventDataType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventDataType" } } } } } } }, "\/api\/event\/event_type\/{identifier}": { "get": { "tags": [ "Event \/ EventType" ], "summary": "This method will get a single BaseEventDataType with the given id", "operationId": "get_event_data_type_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseEventDataType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventDataType" } } } } } }, "put": { "tags": [ "Event \/ EventType" ], "summary": "Update a BaseEventDataType", "operationId": "put_eevent_data_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a BaseEventDataType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventDataType" } } } } } }, "patch": { "tags": [ "Event \/ EventType" ], "summary": "Update a BaseEventDataType", "operationId": "patch_eevent_data_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a BaseEventDataType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseEventDataType" } } } } } } }, "\/api\/event\/bookable_type": { "get": { "tags": [ "Event \/ BookableType" ], "summary": "This method will get all BaseBookableBookableType Objects", "operationId": "get_event_bookable_type_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "shortName", "in": "query", "description": "Kurzname for compact UI labels (e.g. calendars, badges). | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "viewOrder", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "menuName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "menuIcon", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "showAdminMenu", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "showAdminCalendar", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseBookableBookableType objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } } } } } } }, "post": { "tags": [ "Event \/ BookableType" ], "summary": "Add a new BaseBookableBookableType", "operationId": "post_event_bookable_type_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookableBookableType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseBookableBookableType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } } } } } } }, "\/api\/event\/bookable_type\/{identifier}": { "get": { "tags": [ "Event \/ BookableType" ], "summary": "This method will get a single BaseBookableBookableType with the given id", "operationId": "get_event_bookable_type_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseBookableBookableType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } } } } } }, "put": { "tags": [ "Event \/ BookableType" ], "summary": "Update a BaseBookableBookableType", "operationId": "put_event_bookable_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookableBookableType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookableBookableType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } } } } } }, "patch": { "tags": [ "Event \/ BookableType" ], "summary": "Update a BaseBookableBookableType", "operationId": "patch_event_bookable_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseBookableBookableType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseBookableBookableType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } } } } } } }, "\/api\/event\/location_type": { "get": { "tags": [ "Event \/ LocationType" ], "summary": "This method will get all BaseLocationLocationType Objects", "operationId": "get_event_location_type_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "viewOrder", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of BaseLocationLocationType objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseLocationLocationType" } } } } } } }, "post": { "tags": [ "Event \/ LocationType" ], "summary": "Add a new BaseLocationLocationType", "operationId": "post_event_location_type_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocationLocationType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new BaseLocationLocationType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationLocationType" } } } } } } }, "\/api\/event\/location_type\/{identifier}": { "get": { "tags": [ "Event \/ LocationType" ], "summary": "This method will get a single BaseLocationLocationType with the given id", "operationId": "get_event_location_type_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single BaseLocationLocationType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationLocationType" } } } } } }, "put": { "tags": [ "Event \/ LocationType" ], "summary": "Update a BaseLocationLocationType", "operationId": "put_event_location_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocationLocationType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseLocationLocationType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationLocationType" } } } } } }, "patch": { "tags": [ "Event \/ LocationType" ], "summary": "Update a BaseLocationLocationType", "operationId": "patch_event_location_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/BaseLocationLocationType2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a BaseLocationLocationType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BaseLocationLocationType" } } } } } } }, "\/api\/sip\/calls": { "get": { "tags": [ "SipgateAPI \/ Call" ], "summary": "Returns a list of SIPCall", "operationId": "get_get_calls", "parameters": [ { "name": "comType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comCreated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comTitle", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comSearchString", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comDone", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comPersonExt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comDepartmentExt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comCompanyExt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comProjectExt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comPersonInt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comDepartmentInt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comCompanyInt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comProjectInt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "incoming", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "sip_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "number_in", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmperson_in_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmdepartment_in_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmcompany_in_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "number_answering", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmperson_answering_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmdepartment_answering_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmcompany_answering_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "number_out", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmperson_out_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmdepartment_out_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmcompany_out_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "date_new", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "date_answer", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "date_hangup", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reason_hangup", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of SIPCall", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SIPCall" } } } } } } }, "post": { "tags": [ "SipgateAPI \/ Call" ], "summary": "Start a SIPCall", "operationId": "post_post_call", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "call": { "$ref": "#\/components\/schemas\/FormStartCall" } }, "type": "object" } } } }, "responses": { "200": { "description": "Start a SIPCall", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FormStartCall" } } } } } } }, "\/api\/sip\/calls\/{id}": { "get": { "tags": [ "SipgateAPI \/ Call" ], "summary": "Returns a single SIPCall with the given id", "operationId": "get_get_call", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single SIPCall with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SIPCall2" } } } } } }, "put": { "tags": [ "SipgateAPI \/ Call" ], "summary": "Updates a single SIPCall", "operationId": "put_put_call", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "call": { "$ref": "#\/components\/schemas\/SIPCall3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single SIPCall", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SIPCall2" } } } } } }, "patch": { "tags": [ "SipgateAPI \/ Call" ], "summary": "Updates a single SIPCall", "operationId": "patch_put_call", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "call": { "$ref": "#\/components\/schemas\/SIPCall3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single SIPCall", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SIPCall2" } } } } } } }, "\/api\/sip\/calls\/active": { "get": { "tags": [ "SipgateAPI \/ Call" ], "summary": "Returns every call that is currently running\nA call counts as running while it has no hangup and started inside the\nwindow configured in iw_call_active_max_age_minutes. The response is\ndeliberately not cached, it has to be current.", "description": "Answers with an empty list while iw_call_realtime_ui_enabled is off. The\nclients cannot read that setting themselves - it needs the settings scope,\nwhich a normal user does not have - so the switch has to work here, or the\nrunning-calls chip would show up on an installation that never enabled the\nfeature.", "operationId": "get_get_calls_active", "parameters": [ { "name": "comType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comCreated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comTitle", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comSearchString", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comDone", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comPersonExt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comDepartmentExt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comCompanyExt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comProjectExt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comPersonInt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comDepartmentInt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comCompanyInt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comProjectInt", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "incoming", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "sip_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "number_in", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmperson_in_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmdepartment_in_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmcompany_in_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "number_answering", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmperson_answering_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmdepartment_answering_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmcompany_answering_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "number_out", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmperson_out_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmdepartment_out_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "crmcompany_out_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "date_new", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "date_answer", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "date_hangup", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "reason_hangup", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns every call that is currently running", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SIPCall" } } } } } } } }, "\/api\/opendata\/nace_codes\/{identifier}": { "get": { "tags": [ "OpenData \/ NACE Codes" ], "summary": "Get a single NaceCode by identifier (id or code)", "operationId": "get_get_nace_code", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single NaceCode", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NaceCode" } } } } } }, "put": { "tags": [ "OpenData \/ NACE Codes" ], "summary": "Updates a single NaceCode", "operationId": "put_put_nace_code", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NaceCode2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single NaceCode", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NaceCode" } } } } } }, "patch": { "tags": [ "OpenData \/ NACE Codes" ], "summary": "Updates a single NaceCode", "operationId": "patch_put_nace_code", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NaceCode2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single NaceCode", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NaceCode" } } } } } } }, "\/api\/opendata\/nace_codes": { "post": { "tags": [ "OpenData \/ NACE Codes" ], "summary": "Creates a single NaceCode", "operationId": "post_post_nace_code", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/NaceCode2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single NaceCode", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/NaceCode" } } } } } } }, "\/api\/opendata\/microsoft\/login": { "get": { "tags": [ "Social Login \/ Microsoft Login" ], "summary": "Get redirect for microsoft login", "operationId": "get_od_microsoft_login_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get redirect for microsoft login", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpenDataRedirect" } } } } } }, "post": { "tags": [ "Social Login \/ Microsoft Login" ], "summary": "Do log in with microsoft code", "operationId": "post_od_microsoft_login_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/FormLoginUser3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Do log in with microsoft code", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Session" } } } } } }, "delete": { "tags": [ "Social Login \/ Microsoft Login" ], "summary": "Remove microsoft user connection", "operationId": "delete_od_microsoft_login_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Remove microsoft user connection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/opendata\/iw_remote_erp\/login": { "get": { "tags": [ "Social Login \/ iw Remote ERP" ], "summary": "Get redirect for inwendo remote erp login", "operationId": "get_od_iw_remote_erp_login_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get redirect for inwendo remote erp login", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpenDataRedirect" } } } } } }, "post": { "tags": [ "Social Login \/ iw Remote ERP" ], "summary": "Do log in with inwendo remote erp code", "operationId": "post_od_iw_remote_erp_login_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/FormLoginUser3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Do log in with inwendo remote erp code", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Session" } } } } } }, "delete": { "tags": [ "Social Login \/ iw Remote ERP" ], "summary": "Remove inwendo remote erp user connection", "operationId": "delete_od_iw_remote_erp_login_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Remove inwendo remote erp user connection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/opendata\/instagram\/login": { "get": { "tags": [ "Social Login \/ Instagram Login" ], "summary": "Get redirect for instagram login", "operationId": "get_od_instagram_login_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get redirect for instagram login", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpenDataRedirect" } } } } } }, "post": { "tags": [ "Social Login \/ Instagram Login" ], "summary": "Do log in with instagram code", "operationId": "post_od_instagram_login_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/FormLoginUser3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Do log in with instagram code", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Session" } } } } } }, "delete": { "tags": [ "Social Login \/ Instagram Login" ], "summary": "Remove instagram user connection", "operationId": "delete_od_instagram_login_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Remove instagram user connection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/opendata\/facebook\/login": { "get": { "tags": [ "Social Login \/ Facebook Login" ], "summary": "Get redirect for facebook login", "operationId": "get_od_facebook_login_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Get redirect for facebook login", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OpenDataRedirect" } } } } } }, "post": { "tags": [ "Social Login \/ Facebook Login" ], "summary": "Do log in with facebook code", "operationId": "post_od_facebook_login_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/FormLoginUser3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Do log in with facebook code", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Session" } } } } } }, "delete": { "tags": [ "Social Login \/ Facebook Login" ], "summary": "Remove facebook user connection", "operationId": "delete_od_facebook_login_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Remove facebook user connection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/external_login\/redirect_test\/{provider}": { "post": { "tags": [ "Social Login \/ Redirects" ], "summary": "Test oauth code received", "operationId": "post_inwendo_oauth_redirect_test", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".*" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/FormLoginUser3" } }, "type": "object" } } } }, "responses": { "200": { "description": "Test oauth code received", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/opendata\/geocoding": { "get": { "tags": [ "OpenData \/ GeoCoding" ], "summary": "This method returns a Collection of matching GeoCoding results for the searched address.", "operationId": "get_od_geocoding_get", "parameters": [ { "name": "q", "in": "query", "description": "address search", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "This method returns a Collection of matching GeoCoding results for the searched address.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Collection" } } } } } } }, "\/api\/opendata\/bank_data\/iban": { "get": { "tags": [ "OpenData \/ IBAN" ], "summary": "Returns BIC + name of the bank associated with the given IBAN. For invalid IBANs, NULL is returned.", "operationId": "get_od_bank_data_get_iban", "parameters": [ { "name": "iban", "in": "query", "description": "IBAN", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns BIC + name of the bank associated with the given IBAN. For invalid IBANs, NULL is returned.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BankData" } } } } } } }, "\/api\/opendata\/calendar_generate\/{entityType}\/{year}": { "post": { "tags": [ "OpenData \/ Calendar" ], "summary": "Create all missing calendar entries of the given year", "description": "Used by the UI to fill an empty calendar. The requested year is created directly so the user\nsees the result immediately, the remaining years are created by the background command.", "operationId": "post_od_calendar_generate_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Creates the missing calendar days and returns a small summary" } } } }, "\/api\/opendata\/calendar_holiday_regions": { "get": { "tags": [ "OpenData \/ Calendar" ], "summary": "Returns a list of regions that can be selected for the public holiday import entries.", "operationId": "get_od_calendar_holiday_regions_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the selectable holiday regions" } } } }, "\/api\/opendata\/calendar_holiday_import\/{entityType}\/{year}": { "post": { "tags": [ "OpenData \/ Calendar" ], "summary": "Import the public holidays of the given year and region into the calendar", "description": "The work time settings and - for the main calendar - the event settings that should be applied\nto every holiday are part of the request.", "operationId": "post_od_calendar_holiday_import_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Imports the public holidays and returns the changed days" } } } }, "\/api\/opendata\/calendar_range\/{entityType}": { "put": { "tags": [ "OpenData \/ Calendar" ], "summary": "Set the working time flags of every day in a date range (U09: school holiday periods)", "description": "Missing days are created. Days that already carry flags are only replaced when\n`overwrite` is true (default). `clear` = true removes the flags of the range instead.", "operationId": "put_od_calendar_range_update_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates the days of the range and returns a small summary" } } }, "post": { "tags": [ "OpenData \/ Calendar" ], "summary": "Set the working time flags of every day in a date range (U09: school holiday periods)", "description": "Missing days are created. Days that already carry flags are only replaced when\n`overwrite` is true (default). `clear` = true removes the flags of the range instead.", "operationId": "post_od_calendar_range_update_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates the days of the range and returns a small summary" } } }, "patch": { "tags": [ "OpenData \/ Calendar" ], "summary": "Set the working time flags of every day in a date range (U09: school holiday periods)", "description": "Missing days are created. Days that already carry flags are only replaced when\n`overwrite` is true (default). `clear` = true removes the flags of the range instead.", "operationId": "patch_od_calendar_range_update_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Updates the days of the range and returns a small summary" } } } }, "\/api\/opendata\/oauth\/server_clients\/{identifier}": { "get": { "tags": [ "oAuth \/ Server Client" ], "summary": "Get a single OauthServerClient", "operationId": "get_od_oauth_server_client_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single OauthServerClient", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthServerClient" } } } } } }, "put": { "tags": [ "oAuth \/ Server Client" ], "summary": "Updates a single OauthServerClient", "operationId": "put_od_oauth_server_client_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OauthServerClient2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single OauthServerClient", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthServerClient" } } } } } }, "patch": { "tags": [ "oAuth \/ Server Client" ], "summary": "Updates a single OauthServerClient", "operationId": "patch_od_oauth_server_client_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OauthServerClient2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single OauthServerClient", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthServerClient" } } } } } } }, "\/api\/opendata\/oauth\/server_clients": { "post": { "tags": [ "oAuth \/ Server Client" ], "summary": "Creates a single OauthServerClient", "operationId": "post_od_oauth_server_client_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OauthServerClient2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single OauthServerClient", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthServerClient" } } } } } } }, "\/api\/opendata\/oauth\/server_clients_permission\/{clientIdentifier}": { "get": { "tags": [ "oAuth \/ Server Client Permission" ], "summary": "Get a single OauthServerClientPermission", "operationId": "get_od_oauth_server_client_permission_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "clientIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a single OauthServerClientPermission", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthServerClientPermission" } } } } } }, "put": { "tags": [ "oAuth \/ Server Client Permission" ], "summary": "Updates a single OauthServerClientPermission", "operationId": "put_od_oauth_server_client_permission_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "clientIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OauthServerClientPermission2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single OauthServerClientPermission", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthServerClientPermission" } } } } } }, "post": { "tags": [ "oAuth \/ Server Client Permission" ], "summary": "Creates a single OauthServerClientPermission", "operationId": "post_od_oauth_server_client_permission_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "clientIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OauthServerClientPermission2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single OauthServerClientPermission", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthServerClientPermission" } } } } } }, "patch": { "tags": [ "oAuth \/ Server Client Permission" ], "summary": "Updates a single OauthServerClientPermission", "operationId": "patch_od_oauth_server_client_permission_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "clientIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/OauthServerClientPermission2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single OauthServerClientPermission", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OauthServerClientPermission" } } } } } } }, "\/api\/media\/media\/file": { "get": { "tags": [ "Media \/ Media Files" ], "summary": "This method will get all MediaFileInfo Objects", "operationId": "get_cget_media_file", "parameters": [ { "name": "name", "in": "query", "description": "internal name | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicTitle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicSubtitle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicKeywords", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicDate", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicOrder", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicSeason", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicFileMime", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addonData_customFilter", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "archived", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "generatedId3", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaFileInfo objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFileInfo" } } } } } } } }, "\/api\/media\/media\/{groupIdentifier}\/file": { "post": { "tags": [ "Media \/ Media Files" ], "summary": "Add a new MediaFileInfo", "operationId": "post_post_media_file", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "groupIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFileInfo2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MediaFileInfo", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFileInfo" } } } } } } }, "\/api\/media\/media\/{fileIdentifier}\/file": { "get": { "tags": [ "Media \/ Media Files" ], "summary": "This method will get a single MediaFileInfo with the given id", "operationId": "get_get_media_file", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "fileIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaFileInfo", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFileInfo" } } } } } }, "put": { "tags": [ "Media \/ Media Files" ], "summary": "Update a MediaFileInfo", "operationId": "put_put_media_file", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "fileIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFileInfo2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaFileInfo", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFileInfo" } } } } } }, "patch": { "tags": [ "Media \/ Media Files" ], "summary": "Update a MediaFileInfo", "operationId": "patch_put_media_file", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "fileIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFileInfo2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaFileInfo", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFileInfo" } } } } } } }, "\/api\/media\/mediagroup\/rss\/{groupIdentifier}": { "get": { "summary": "This method will get a single MediaGroup as an RSS feed", "operationId": "get_inwendo_media_group_rss", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "groupIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "head": { "summary": "This method will get a single MediaGroup as an RSS feed", "operationId": "head_inwendo_media_group_rss", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "groupIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/mediagroup": { "get": { "tags": [ "Media \/ Media Groups" ], "summary": "Returns a list of media groups", "operationId": "get_media_group_cget", "parameters": [ { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicTitle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "groupType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "slugIdentifier", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "itemOfTheDay", "in": "query", "description": "This property is used to mark an entity as the item of the day. | Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "archived", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "addonData_shopify_product_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addonData_vimeo_id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of media groups", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaGroup" } } } } } } }, "post": { "tags": [ "Media \/ Media Groups" ], "summary": "Add a new MediaGroup", "operationId": "post_media_group_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MediaGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaGroup3" } } } } } } }, "\/api\/media\/mediagroup\/{identifier}": { "get": { "tags": [ "Media \/ Media Groups" ], "summary": "Returns a single media group with the given id or token", "operationId": "get_media_group_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single media group with the given id or token", "content": { "application\/json": { "schema": { "oneOf": [ { "$ref": "#\/components\/schemas\/MediaGroup3" }, { "$ref": "#\/components\/schemas\/MediaGroup" }, { "$ref": "#\/components\/schemas\/MediaGroup" } ] } } } } } }, "put": { "tags": [ "Media \/ Media Groups" ], "summary": "Update a MediaGroup", "operationId": "put_media_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaGroup3" } } } } } }, "patch": { "tags": [ "Media \/ Media Groups" ], "summary": "Update a MediaGroup", "operationId": "patch_media_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaGroup2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaGroup3" } } } } } } }, "\/api\/media\/mediagroup\/{groupIdentifier}\/entries": { "get": { "tags": [ "Media \/ Media Files", "Media \/ Media Groups" ], "summary": "Returns a list of media files for a single media group", "operationId": "get_media_group_entries", "parameters": [ { "name": "name", "in": "query", "description": "internal name | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicTitle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicSubtitle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicKeywords", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicDate", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicOrder", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicSeason", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "publicFileMime", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "addonData_customFilter", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "archived", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "generatedId3", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "groupIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of media files for a single media group", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFileInfo3" } } } } } } } }, "\/api\/media\/mediafile\/proxy\/{fileIdentifier}": { "get": { "summary": "This method will proxy a MediaFile", "operationId": "get_inwendo_media_file_proxy", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "fileIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "head": { "summary": "This method will proxy a MediaFile", "operationId": "head_inwendo_media_file_proxy", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "fileIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/mediafile\/proxy\/{fileIdentifier}\/{wildcard}": { "get": { "summary": "This method will proxy a MediaFile", "operationId": "get_inwendo_media_file_proxy_wildcard", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "fileIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wildcard", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } }, "head": { "summary": "This method will proxy a MediaFile", "operationId": "head_inwendo_media_file_proxy_wildcard", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "fileIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wildcard", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/mediafile\/proxy_attachment\/{downloadLink}": { "get": { "summary": "This method will proxy an Attachment", "operationId": "get_inwendo_media_file_attachment_proxy", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "downloadLink", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "head": { "summary": "This method will proxy an Attachment", "operationId": "head_inwendo_media_file_attachment_proxy", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "downloadLink", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/mediafile\/proxy_attachment\/{downloadLink}\/download\/bylink": { "get": { "summary": "This method will proxy an Attachment", "operationId": "get_inwendo_media_file_attachment_proxy_direct_replacement", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "downloadLink", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "head": { "summary": "This method will proxy an Attachment", "operationId": "head_inwendo_media_file_attachment_proxy_direct_replacement", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "downloadLink", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/url\/remote\/proxy\/{urlIdentifier}\/{wildcard}": { "get": { "summary": "This method will proxy a RemoteMediaUrl", "operationId": "get_inwendo_remote_media_url_proxy", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "urlIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wildcard", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } }, "post": { "summary": "This method will proxy a RemoteMediaUrl", "operationId": "post_inwendo_remote_media_url_proxy", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "urlIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wildcard", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } }, "head": { "summary": "This method will proxy a RemoteMediaUrl", "operationId": "head_inwendo_remote_media_url_proxy", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "urlIdentifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "wildcard", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/url\/remote\/proxy\/{urlIdentifier}": { "get": { "summary": "This method will proxy a RemoteMediaUrl", "operationId": "get_inwendo_remote_media_url_proxy_no_wildcard", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "urlIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "post": { "summary": "This method will proxy a RemoteMediaUrl", "operationId": "post_inwendo_remote_media_url_proxy_no_wildcard", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "urlIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "head": { "summary": "This method will proxy a RemoteMediaUrl", "operationId": "head_inwendo_remote_media_url_proxy_no_wildcard", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "urlIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/news_article": { "get": { "tags": [ "Media \/ News Article" ], "summary": "Returns a list of news \/ help articles", "operationId": "get_media_news_article_cget", "parameters": [ { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "publicTitle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "newsType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "slugIdentifier", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "publicKeywords", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "publishDate", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "unpublishDate", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "articleSpace", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "viewOrder", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "integer" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of news \/ help articles", "content": { "application\/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticle" } }, { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticle2" } }, { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticle3" } } ] } } } } } }, "post": { "tags": [ "Media \/ News Article" ], "summary": "Creates a single news \/ help article", "operationId": "post_media_news_article_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaNewsArticle4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single news \/ help article", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticle5" } } } } } } }, "\/api\/media\/news_article\/{identifier}": { "get": { "tags": [ "Media \/ News Article" ], "summary": "Returns a single news \/ help article with the given id or token", "operationId": "get_media_news_article_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single news \/ help article with the given id or token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticle6" } } } } } }, "put": { "tags": [ "Media \/ News Article" ], "summary": "Updates a single news \/ help article", "operationId": "put_media_news_article_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaNewsArticle4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single news \/ help article", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticle5" } } } } } }, "delete": { "tags": [ "Media \/ News Article" ], "summary": "Deletes a single news \/ help article", "operationId": "delete_media_news_article_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single news \/ help article", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticle7" } } } } } }, "patch": { "tags": [ "Media \/ News Article" ], "summary": "Updates a single news \/ help article", "operationId": "patch_media_news_article_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaNewsArticle4" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single news \/ help article", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticle5" } } } } } } }, "\/api\/media\/news_article_highlight": { "get": { "tags": [ "Media \/ News Article" ], "summary": "Returns a single highlighted news article. If multiple highlighted articles match the query, one is selected randomly. Result is cached for 10 minutes.", "operationId": "get_media_news_article_get_highlight", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a single highlighted news article", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticle8" } } } } } } }, "\/api\/media\/news_article_type": { "get": { "tags": [ "Media \/ NewsArticleType" ], "summary": "This method will get all MediaNewsArticleDataType Objects", "operationId": "get_media_news_article_data_type_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaNewsArticleDataType objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticleDataType" } } } } } } }, "post": { "tags": [ "Media \/ NewsArticleType" ], "summary": "Add a new MediaNewsArticleDataType", "operationId": "post_media_news_article_data_type_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new MediaNewsArticleDataType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticleDataType" } } } } } } }, "\/api\/media\/news_article_type\/{identifier}": { "get": { "tags": [ "Media \/ NewsArticleType" ], "summary": "This method will get a single MediaNewsArticleDataType with the given id", "operationId": "get_media_news_article_data_type_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaNewsArticleDataType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticleDataType" } } } } } }, "put": { "tags": [ "Media \/ NewsArticleType" ], "summary": "Update a MediaNewsArticleDataType", "operationId": "put_media_news_article_data_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a MediaNewsArticleDataType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticleDataType" } } } } } }, "patch": { "tags": [ "Media \/ NewsArticleType" ], "summary": "Update a MediaNewsArticleDataType", "operationId": "patch_media_news_article_data_type_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a MediaNewsArticleDataType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticleDataType" } } } } } } }, "\/api\/help\/help_article": { "get": { "tags": [ "Helpcenter \/ Help Article" ], "summary": "Returns a list of help articles", "operationId": "get_media_help_article_cget", "parameters": [ { "name": "name", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "publicTitle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "newsType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "slugIdentifier", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "publicKeywords", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "publishDate", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "unpublishDate", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "articleSpace", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "name": "viewOrder", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE, C1", "required": false, "schema": { "type": "integer" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "person", "in": "query", "description": "Requires access right: SCOPE, C1", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of help articles", "content": { "application\/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticle2" } } ] } } } } } } }, "\/api\/help\/help_article\/{identifier}": { "get": { "tags": [ "Helpcenter \/ Help Article" ], "summary": "Returns a single help article with the given id or token", "operationId": "get_media_help_article_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single help article with the given id or token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaNewsArticle9" } } } } } } }, "\/api\/media\/article_space": { "get": { "tags": [ "Media \/ Article Space" ], "summary": "Returns a list of article spaces", "operationId": "get_media_article_space_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of article spaces", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace" } } } } } } }, "post": { "tags": [ "Media \/ Article Space" ], "summary": "Creates a single article space", "operationId": "post_media_article_space_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaArticleSpace2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single article space", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaArticleSpace3" } } } } } } }, "\/api\/media\/article_space\/{identifier}": { "get": { "tags": [ "Media \/ Article Space" ], "summary": "Returns a single article space with the given id", "operationId": "get_media_article_space_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single article space with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaArticleSpace3" } } } } } }, "put": { "tags": [ "Media \/ Article Space" ], "summary": "Updates a single article space", "operationId": "put_media_article_space_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaArticleSpace2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single article space", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaArticleSpace3" } } } } } }, "delete": { "tags": [ "Media \/ Article Space" ], "summary": "Deletes a single MediaArticleSpace", "operationId": "delete_media_article_space_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single MediaArticleSpace", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaArticleSpace10" } } } } } }, "patch": { "tags": [ "Media \/ Article Space" ], "summary": "Updates a single article space", "operationId": "patch_media_article_space_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaArticleSpace2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single article space", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaArticleSpace3" } } } } } } }, "\/api\/media\/questionnaire": { "get": { "tags": [ "Media \/ MediaQuestionnaire" ], "summary": "This method will get all MediaQuestionnaire", "operationId": "get_media_question_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaQuestionnaire objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaire" } } } } } } }, "post": { "tags": [ "Media \/ MediaQuestionnaire" ], "summary": "Add a new MediaQuestionnaire", "operationId": "post_media_question_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new MediaQuestionnaire", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaire2" } } } } } } }, "\/api\/media\/questionnaire\/{identifier}": { "get": { "tags": [ "Media \/ MediaQuestionnaire" ], "summary": "This method will get a single MediaQuestionnaire with the given id or token", "operationId": "get_media_question_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "draftToken", "in": "query", "description": "Token (logged in: id or token) of an own draft answer for this questionnaire - grants read access even without access tags", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaQuestionnaire", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaire" } } } } } }, "put": { "tags": [ "Media \/ MediaQuestionnaire" ], "summary": "Update a MediaQuestionnaire", "operationId": "put_media_question_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a MediaQuestionnaire", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaire2" } } } } } }, "delete": { "tags": [ "Media \/ MediaQuestionnaire" ], "summary": "Deletes a single MediaQuestionnaire", "operationId": "delete_media_question_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single MediaQuestionnaire", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaire" } } } } } }, "patch": { "tags": [ "Media \/ MediaQuestionnaire" ], "summary": "Update a MediaQuestionnaire", "operationId": "patch_media_question_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a MediaQuestionnaire", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaire2" } } } } } } }, "\/api\/media\/questionnaire\/{identifier}\/statistics": { "get": { "tags": [ "Media \/ MediaQuestionnaire" ], "summary": "Get statistics for a MediaQuestionnaire with optional filtering.", "description": "When filters are applied, includes comparison with unfiltered results.\n\nSupported filter parameters:\n- minAge: Minimum age\n- maxAge: Maximum age\n- gender: Gender filter (M, W, D, U)\n- gradeLevel: Grade level\n- schoolClass: School class\n- naceSection: NACE section code (A-U)\n- naceCode: NACE code (e.g., 01.11, 62.01)\n- mediaQuestionnaireAnswerGroup: Filter to answers from specific group", "operationId": "get_media_question_statistics", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/questionnaire_answer": { "get": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "This method will get all MediaQuestionnaireAnswer Objects", "operationId": "get_media_question_answer_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaQuestionnaireAnswer objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer" } } } } } } }, "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Add a new MediaQuestionnaireAnswer", "operationId": "post_media_question_answer_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new MediaQuestionnaireAnswer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer2" } } } } } } }, "\/api\/media\/questionnaire_answer\/{identifier}": { "get": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "This method will get a single MediaQuestionnaireAnswer with the given id or token", "operationId": "get_media_question_answer_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaQuestionnaireAnswer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer3" } } } } } }, "put": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Update a MediaQuestionnaireAnswer", "operationId": "put_media_question_answer_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a MediaQuestionnaireAnswer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer3" } } } } } }, "delete": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "This method will delete a single MediaQuestionnaireAnswer with the given id or token", "operationId": "delete_media_question_answer_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single MediaQuestionnaireAnswer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer11" } } } } } }, "patch": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Update a MediaQuestionnaireAnswer", "operationId": "patch_media_question_answer_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a MediaQuestionnaireAnswer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer3" } } } } } } }, "\/api\/media\/customer\/questionnaire_answer": { "get": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "This method will get all MediaQuestionnaireAnswer Objects for customer", "operationId": "get_media_question_answer_cget_customer", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaQuestionnaireAnswer objects for customer", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer5" } } } } } } }, "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Add a new MediaQuestionnaireAnswer as customer", "operationId": "post_media_question_answer_post_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new MediaQuestionnaireAnswer as customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer5" } } } } } } }, "\/api\/media\/customer\/questionnaire_answer_draft": { "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Add a new MediaQuestionnaireAnswer draft as customer", "operationId": "post_media_question_answer_post_customer_draft", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new MediaQuestionnaireAnswer draft as customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer7" } } } } } } }, "\/api\/media\/customer\/questionnaire_answer_draft\/{identifier}": { "put": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Update MediaQuestionnaireAnswer draft as customer", "operationId": "put_media_question_answer_put_customer_draft", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update MediaQuestionnaireAnswer draft as customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer7" } } } } } } }, "\/api\/media\/public\/questionnaire_answer": { "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Add a new MediaQuestionnaireAnswer for questionnaire as a guest", "operationId": "post_media_question_answer_post_public", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer8" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MediaQuestionnaireAnswer for questionnaire as a guest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer9" } } } } } } }, "\/api\/media\/public\/questionnaire_answer_draft": { "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Add a new MediaQuestionnaireAnswer draft for questionnaire as a guest", "operationId": "post_media_question_answer_post_public_draft", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer8" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MediaQuestionnaireAnswer draft for questionnaire as a guest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer9" } } } } } } }, "\/api\/media\/public\/questionnaire_answer_draft\/{identifier}": { "put": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Update MediaQuestionnaireAnswer draft for questionnaire as a guest", "operationId": "put_media_question_answer_put_public_draft", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer8" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update MediaQuestionnaireAnswer draft for questionnaire as a guest", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer9" } } } } } } }, "\/api\/media\/public\/test_questionnaire_answer": { "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Test adding a new MediaQuestionnaireAnswer as customer \/ public", "operationId": "post_media_question_answer_post_public_test", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer8" } }, "type": "object" } } } }, "responses": { "200": { "description": "Test adding a new MediaQuestionnaireAnswer as customer \/ public", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerTest" } } } } } } }, "\/api\/media\/public\/questionnaire_answer\/{identifier}\/adds\/attachments": { "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Add an Attachment to a draft MediaQuestionnaireAnswer as a guest (token based)", "operationId": "post_media_question_answer_post_public_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/public\/questionnaire_answer\/{identifier}\/deletes\/attachments": { "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Remove an Attachment from a draft MediaQuestionnaireAnswer as a guest (token based)", "operationId": "post_media_question_answer_delete_public_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/questionnaire_answer\/{identifier}\/adds\/attachments": { "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Add an Attachment to a MediaQuestionnaireAnswer", "operationId": "post_media_question_answer_post_add_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add an Attachment to a MediaQuestionnaireAnswer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer10" } } } } } } }, "\/api\/media\/questionnaire_answer\/{identifier}\/deletes\/attachments": { "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Remove an Attachment from Ticket", "operationId": "post_media_question_answer_post_delete_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Remove an Attachment from MediaQuestionnaireAnswer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer10" } } } } } } }, "\/api\/media\/questionnaire_answer\/{identifier}\/pdf": { "get": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Get PDF for a MediaQuestionnaireAnswer using the questionnaire's result template", "operationId": "get_media_question_answer_get_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/questionnaire_answer\/{identifier}\/ai_comparison_xlsx": { "get": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Get the AI comparison of a MediaQuestionnaireAnswer as Excel file: one row per answered question\nwith the answer, the AI comparison prompt and the AI result", "operationId": "get_media_question_answer_get_ai_comparison_xlsx", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/questionnaire_answer\/{identifier}\/create_group": { "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Create a new MediaQuestionnaireAnswerGroup from an existing single answer", "operationId": "post_media_question_answer_post_create_group", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Create a new group from a single answer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup" } } } } } } }, "\/api\/media\/questionnaire_answer\/{identifier}\/reprocess_ai": { "post": { "tags": [ "Media \/ MediaQuestionnaire Answer" ], "summary": "Restart the AI processing (AI comparison or AI chat evaluation) of a submitted MediaQuestionnaireAnswer", "operationId": "post_media_question_answer_post_reprocess_ai", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Restart the AI processing of a MediaQuestionnaireAnswer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer3" } } } } } } }, "\/api\/media\/questionnaire_answer\/{identifier}\/generate_clarifications": { "post": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Creates the clarification points of an answer again from its AI comparison results.", "description": "Points somebody already worked on and manual points are kept.", "operationId": "post_media_question_answer_post_generate_clarifications", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Creates the clarification points of a MediaQuestionnaireAnswer again", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer3" } } } } } } }, "\/api\/media\/questionnaire_answer\/{identifier}\/complete_review": { "post": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Completes the review of an answer once every clarification point is decided or dismissed.", "description": "The result template (report) follows, as it does without the second loop.", "operationId": "post_media_question_answer_post_complete_review", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completes the review of a MediaQuestionnaireAnswer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer3" } } } } } } }, "\/api\/media\/questionnaire_clarification": { "get": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Returns the clarification points (filter with mediaQuestionnaireAnswer)", "operationId": "get_media_questionnaire_clarification_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "mediaQuestionnaireAnswer", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contentAnswer", "in": "query", "description": "The answered question this point is about. Null for general points of the auditor. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "contentKey", "in": "query", "description": "Stable key of the question (MediaQuestionnaireContent::$contentKey), copied from the content answer | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "AI or MANUAL | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "OPEN, ANSWERED, RESOLVED, DISMISSED | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "aiVerdict", "in": "query", "description": "Rating of the AI after the comparison: PASSED, NEEDS_CLARIFICATION, FAILED, NOT_APPLICABLE (null if the AI gave none) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "finalVerdict", "in": "query", "description": "Decision of the auditor: PASSED, FAILED, NOT_APPLICABLE | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "viewOrder", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaQuestionnaireClarification objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification" } } } } } } }, "post": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Adds a clarification point of the auditor (source MANUAL), e.g. a finding of an on-premise AI check", "operationId": "post_media_questionnaire_clarification_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MediaQuestionnaireClarification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification" } } } } } } }, "\/api\/media\/questionnaire_clarification\/{identifier}": { "get": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Returns a single clarification point", "operationId": "get_media_questionnaire_clarification_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaQuestionnaireClarification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification" } } } } } }, "put": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Updates a clarification point (question, response of the customer, decision of the auditor)", "operationId": "put_media_questionnaire_clarification_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaQuestionnaireClarification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification" } } } } } }, "delete": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Deletes a clarification point (soft delete)", "operationId": "delete_media_questionnaire_clarification_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a MediaQuestionnaireClarification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification" } } } } } }, "patch": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Updates a clarification point (question, response of the customer, decision of the auditor)", "operationId": "patch_media_questionnaire_clarification_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaQuestionnaireClarification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification" } } } } } } }, "\/api\/media\/questionnaire_clarification\/{identifier}\/evaluate": { "post": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Starts the AI re-evaluation of a clarification point with the response and the late evidence", "operationId": "post_media_questionnaire_clarification_post_evaluate", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Starts the AI re-evaluation of a MediaQuestionnaireClarification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification" } } } } } } }, "\/api\/media\/questionnaire_clarification\/{identifier}\/adds\/attachments": { "post": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Links a late evidence document (an uploaded Attachment) to a clarification point", "operationId": "post_media_questionnaire_clarification_post_add_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add an Attachment to a MediaQuestionnaireClarification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification" } } } } } } }, "\/api\/media\/questionnaire_clarification\/{identifier}\/deletes\/attachments": { "post": { "tags": [ "Media \/ Questionnaire Clarifications" ], "summary": "Removes a late evidence document from a clarification point", "operationId": "post_media_questionnaire_clarification_post_delete_attachment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Remove an Attachment from a MediaQuestionnaireClarification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireClarification" } } } } } } }, "\/api\/media\/questionnaire_answer_group": { "get": { "tags": [ "Media \/ MediaQuestionnaire Answer Group" ], "summary": "This method will get all MediaQuestionnaireAnswerGroup Objects", "operationId": "get_media_question_answer_group_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaQuestionnaireAnswerGroup objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup2" } } } } } } }, "post": { "tags": [ "Media \/ MediaQuestionnaire Answer Group" ], "summary": "Add a new MediaQuestionnaireAnswerGroupController", "operationId": "post_media_question_answer_group_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new MediaQuestionnaireAnswerGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup" } } } } } } }, "\/api\/media\/questionnaire_answer_group\/{identifier}": { "get": { "tags": [ "Media \/ MediaQuestionnaire Answer Group" ], "summary": "This method will get a single MediaQuestionnaireAnswerGroup with the given id or token", "operationId": "get_media_question_answer_group_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaQuestionnaireAnswerGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup10" } } } } } }, "put": { "tags": [ "Media \/ MediaQuestionnaire Answer Group" ], "summary": "Update a MediaQuestionnaireAnswerGroup", "operationId": "put_media_question_answer_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a MediaQuestionnaireAnswerGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup" } } } } } }, "delete": { "tags": [ "Media \/ MediaQuestionnaire Answer Group" ], "summary": "This method will delete a single MediaQuestionnaireAnswerGroup with the given id or token", "operationId": "delete_media_question_answer_group_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single MediaQuestionnaireAnswerGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup10" } } } } } }, "patch": { "tags": [ "Media \/ MediaQuestionnaire Answer Group" ], "summary": "Update a MediaQuestionnaireAnswerGroup", "operationId": "patch_media_question_answer_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a MediaQuestionnaireAnswerGroup", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup" } } } } } } }, "\/api\/media\/customer\/questionnaire_answer_group": { "get": { "tags": [ "Media \/ MediaQuestionnaire Answer Group" ], "summary": "This method will get all MediaQuestionnaireAnswerGroup Objects for customer", "operationId": "get_media_question_answer_group_cget_customer", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaQuestionnaireAnswerGroup objects for customer", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup4" } } } } } } }, "post": { "tags": [ "Media \/ MediaQuestionnaire Answer Group" ], "summary": "Add a new MediaQuestionnaireAnswerGroup as customer", "operationId": "post_media_question_answer_group_post_customer", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new MediaQuestionnaireAnswerGroup as customer", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup4" } } } } } } }, "\/api\/media\/questionnaire_answer_group\/{identifier}\/pdf": { "get": { "tags": [ "Media \/ MediaQuestionnaire Answer Group" ], "summary": "Get PDF for a MediaQuestionnaireAnswerGroup using the questionnaire's result template", "operationId": "get_media_question_answer_group_get_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/questionnaire_answer_group\/{identifier}\/xlsx": { "get": { "tags": [ "Media \/ MediaQuestionnaire Answer Group" ], "summary": "Get Excel matrix export for a MediaQuestionnaireAnswerGroup.", "description": "Generates a matrix-style Excel with dimensions as column groups, questions as columns,\nand respondents as rows - including Gesamt, Mittelwert (Frage), and Mittelwert (Dimension) formulas.", "operationId": "get_media_question_answer_group_get_xlsx", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/card_button": { "get": { "tags": [ "Media \/ MediaCardButton" ], "summary": "This method will get all MediaCardButton", "operationId": "get_media_card_button_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaCardButton objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaCardButton" } } } } } } }, "post": { "tags": [ "Media \/ MediaCardButton" ], "summary": "Add a new MediaCardButton", "operationId": "post_media_card_button_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Add a new MediaCardButton", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaCardButton2" } } } } } } }, "\/api\/media\/card_button\/{identifier}": { "get": { "tags": [ "Media \/ MediaCardButton" ], "summary": "This method will get a single MediaCardButton with the given id or token", "operationId": "get_media_card_button_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaCardButton", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaCardButton" } } } } } }, "put": { "tags": [ "Media \/ MediaCardButton" ], "summary": "Update a MediaCardButton", "operationId": "put_media_card_button_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a MediaCardButton", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaCardButton2" } } } } } }, "delete": { "tags": [ "Media \/ MediaCardButton" ], "summary": "Deletes a single MediaCardButton", "operationId": "delete_media_card_button_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deletes a single MediaCardButton", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaCardButton" } } } } } }, "patch": { "tags": [ "Media \/ MediaCardButton" ], "summary": "Update a MediaCardButton", "operationId": "patch_media_card_button_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a MediaCardButton", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaCardButton2" } } } } } } }, "\/api\/notification\/mass_notification": { "post": { "tags": [ "Notification \/ MassNotification" ], "summary": "Add a new MassUserNotification", "operationId": "post_notification_mass_notification_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MassUserNotification" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MassUserNotification", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MassUserNotification2" } } } } } } }, "\/api\/notification\/mass_notification\/simple_references": { "get": { "tags": [ "Notification \/ MassNotification" ], "summary": "Get a list of SimpleReference", "operationId": "get_notification_mass_notification_simple_references", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "className", "in": "query", "description": "The className to get the references for. e.g. person", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Get a list of SimpleReference", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SimpleReference" } } } } } } } }, "\/api\/notification\/mass_notification\/placeholders": { "get": { "tags": [ "Notification \/ MassNotification" ], "summary": "Return the list of Twig placeholders available for a given reference class or for one of the\nsettings backed mail templates. Used by the template editor \/ mass-notification editor and by\nthe mail template settings screens to power click-to-insert chips.", "description": "Exactly one of className \/ templateKey has to be given.", "operationId": "get_notification_mass_notification_placeholders", "parameters": [ { "name": "className", "in": "query", "description": "FQCN or short name of the reference class (e.g. 'CRMPerson' or full FQCN).", "required": false, "schema": { "type": "string" } }, { "name": "templateKey", "in": "query", "description": "Settings key of a mail template (e.g. 'templates_mail_ticket_created_txt_twig').", "required": false, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/notification\/messenger_message": { "get": { "tags": [ "Notification \/ MessengerMessage" ], "summary": "Returns a list of all MessengerMessages", "operationId": "get_notification_messenger_message_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "outbound | inbound | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "description": "sms | whatsapp | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "INFOBIP | SINCH | CM | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "description": "E.164 digits without + of the person (recipient or sender) | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "sent | failed | received | Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "providerMessageId", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "userNotification", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "chatroom", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "chatroomMessage", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE, SCOPE_LIST", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all MessengerMessages", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MessengerMessage" } } } } } } } }, "\/api\/notification\/messenger_message\/{identifier}": { "get": { "tags": [ "Notification \/ MessengerMessage" ], "summary": "Returns a single MessengerMessage entry.", "operationId": "get_notification_messenger_message_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single MessengerMessage", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MessengerMessage2" } } } } } } }, "\/api\/messenger\/webhook\/{provider}\/{token}": { "get": { "tags": [ "Notification \/ Messenger" ], "summary": "Handles an incoming message.", "operationId": "get_notification_messenger_webhook", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "pattern": "infobip|sinch|cm|meta|twilio|INFOBIP|SINCH|CM|META|TWILIO", "enum": [ "infobip", "sinch", "cm", "meta", "twilio", "INFOBIP", "SINCH", "CM", "META", "TWILIO" ] } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[A-Za-z0-9_\\-]+" } } ], "responses": { "200": { "description": "Inbound messages accepted (Twilio: TwiML, Meta verification: the challenge)" }, "401": { "description": "Invalid signature" }, "404": { "description": "Unknown provider or token" } } }, "post": { "tags": [ "Notification \/ Messenger" ], "summary": "Handles an incoming message.", "operationId": "post_notification_messenger_webhook", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "pattern": "infobip|sinch|cm|meta|twilio|INFOBIP|SINCH|CM|META|TWILIO", "enum": [ "infobip", "sinch", "cm", "meta", "twilio", "INFOBIP", "SINCH", "CM", "META", "TWILIO" ] } }, { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[A-Za-z0-9_\\-]+" } } ], "responses": { "200": { "description": "Inbound messages accepted (Twilio: TwiML, Meta verification: the challenge)" }, "401": { "description": "Invalid signature" }, "404": { "description": "Unknown provider or token" } } } }, "\/api\/dw\/import\/file\/{id}\/download": { "get": { "tags": [ "DataWarehouse \/ ImportFile" ], "summary": "This method will download the original uploaded file of an ImportFile - super admin only", "operationId": "get_dw_import_file_download", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "head": { "tags": [ "DataWarehouse \/ ImportFile" ], "summary": "This method will download the original uploaded file of an ImportFile - super admin only", "operationId": "head_dw_import_file_download", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/dw\/webhook": { "get": { "tags": [ "DataWarehouse \/ Webhooks" ], "summary": "Returns a list of webhooks", "operationId": "get_dw_registered_webhook_cget", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "referenceClassName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "referenceIds", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "databaseAction", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "notificationType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "notificationUrl", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requestTimeout", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "includeWritePermission", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of webhooks", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/RegisteredWebhook" } } } } } } }, "post": { "tags": [ "DataWarehouse \/ Webhooks" ], "summary": "Add a new webhook", "operationId": "post_dw_registered_webhook_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/RegisteredWebhook2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new webhook", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RegisteredWebhook" } } } } } } }, "\/api\/dw\/webhook\/{id}": { "get": { "tags": [ "DataWarehouse \/ Webhooks" ], "summary": "Return a single webhook with the given id", "operationId": "get_dw_registered_webhook_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a single webhook with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RegisteredWebhook" } } } } } }, "put": { "tags": [ "DataWarehouse \/ Webhooks" ], "summary": "Update a single webhook with the given id", "operationId": "put_dw_registered_webhook_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/RegisteredWebhook2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single webhook with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RegisteredWebhook" } } } } } }, "patch": { "tags": [ "DataWarehouse \/ Webhooks" ], "summary": "Update a single webhook with the given id", "operationId": "patch_dw_registered_webhook_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/RegisteredWebhook2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a single webhook with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RegisteredWebhook" } } } } } } }, "\/api\/dw\/webhook\/{id}\/debug_mode": { "post": { "tags": [ "DataWarehouse \/ Webhooks" ], "summary": "Switch the debug mode of a single webhook on or off", "description": "While debug mode is on, every execution of this webhook writes a\nWebhookLog and pushes it to the returned MQTT topic. The window is\ncapped at RegisteredWebhook::DEBUG_MODE_MAX_SECONDS and expires on its\nown \u2014 a client that never sends the \"off\" call cannot leave it running.", "operationId": "post_dw_registered_webhook_debug_mode_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "data": { "properties": { "active": { "description": "Switch debug mode on or off", "type": "boolean", "example": true }, "seconds": { "description": "Requested length of the debug window, clamped to 600 seconds", "type": "integer", "example": 600 } }, "type": "object" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/dw\/webhook_log": { "get": { "tags": [ "DataWarehouse \/ Webhooks" ], "summary": "Returns a list of webhook log entries", "operationId": "get_dw_webhook_log_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "webhook", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "runIdentifier", "in": "query", "description": "Groups all rows that belong to one dispatch of one webhook, so the UI can fold request and response into a single entry. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "level", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "step", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "notificationType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "referenceClassName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "referenceId", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "databaseAction", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "responseCode", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of webhook log entries", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebhookLog" } } } } } } } }, "\/api\/dw\/webhook_log\/{id}": { "get": { "tags": [ "DataWarehouse \/ Webhooks" ], "summary": "Return a single webhook log entry with the given id", "operationId": "get_dw_webhook_log_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a single webhook log entry with the given id", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WebhookLog" } } } } } } }, "\/api\/dw\/unified_search": { "get": { "tags": [ "DataWarehouse \/ Search" ], "summary": "Returns a list of search results (max. 20 per entity)", "operationId": "get_dw_unified_search_cget", "parameters": [ { "name": "search_data_aggregation", "in": "query", "description": "Options: grouped, merged", "required": false, "schema": { "type": "string" } }, { "name": "search_data_entities", "in": "query", "description": "Comma separated list of entities to search in. Options: baseevent, baselocation, unifiedcategory, mediagroup, mediafileinfo, medianewsarticle", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of search results (max. 20 per entity)", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SimpleReference" } } } } } } } }, "\/api\/dw\/unified_search\/favorites": { "get": { "tags": [ "DataWarehouse \/ Search" ], "summary": "Returns grouped favorite entities for the current user based on customerFavoriteData.", "description": "Reads the user's customer_favorite_data, extracts entity IDs per type,\nand forwards requests to entity controllers with the favoriteIds filter.", "operationId": "get_dw_unified_search_favorites", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/templates\/flexible_latex_template_tools\/editor_meta": { "get": { "tags": [ "Latex \/ FlexibleLatexTemplate" ], "summary": "Everything the template editor needs: data types for the class dropdown, the id rules,\nthe AI marker syntax and which AI features are available on this server.", "operationId": "get_latex_flexible_latex_template_editor_meta", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Editor meta data of flexible templates" } } } }, "\/api\/templates\/flexible_latex_template_tools\/id_check": { "get": { "tags": [ "Latex \/ FlexibleLatexTemplate" ], "summary": "Validates an id for a new template and suggests a free id (from the name or the duplicated template).", "operationId": "get_latex_flexible_latex_template_id_check", "parameters": [ { "name": "id", "in": "query", "description": "ID to validate", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Template name the suggestion is built from", "required": false, "schema": { "type": "string" } }, { "name": "base_id", "in": "query", "description": "ID of the duplicated template", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Validation result and suggestion" } } } }, "\/api\/templates\/flexible_latex_template_tools\/check": { "post": { "tags": [ "Latex \/ FlexibleLatexTemplate" ], "summary": "Runs the template check (\"Pr\u00fcflauf\") for the posted, not yet saved template state: Twig syntax,\nrendering with a minimal and a maximal data set of the data type and the PDF rendering.", "description": "Fields that are not posted are taken from the saved template with the same id.", "operationId": "post_latex_flexible_latex_template_check", "parameters": [ { "name": "render_pdf", "in": "query", "description": "false skips the PDF rendering (default true)", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Check report" } } } }, "\/api\/templates\/flexible_latex_template_tools\/ai_import": { "post": { "tags": [ "Latex \/ FlexibleLatexTemplate" ], "summary": "Creates a template proposal from a PDF \/ image upload or a web page via OCR + AI. The result is\nnot saved, the editor opens it like a duplicated template.", "operationId": "post_latex_flexible_latex_template_ai_import", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "multipart\/form-data": { "schema": { "properties": { "file": { "description": "PDF or image (PNG \/ JPG)", "type": "string", "format": "binary" }, "url": { "description": "Web page to convert instead of a file", "type": "string" }, "render_type": { "description": "latex or html", "type": "string" }, "tag": { "description": "Data type of the template (reference class key)", "type": "string" }, "name": { "description": "Name of the new template", "type": "string" }, "hint": { "description": "Additional instructions for the AI", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Template proposal with check report" } } } }, "\/api\/settings\/screens": { "get": { "tags": [ "Settings \/ Screens" ], "summary": "Get all settings screens the user may open, with the groups of the setup assistant", "operationId": "get_settings_screen_cget", "parameters": [ { "name": "lang", "in": "query", "description": "Language of the texts, de or en", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the screens and their groups, without values" } } } }, "\/api\/settings\/screens\/{identifier}": { "get": { "tags": [ "Settings \/ Screens" ], "summary": "Get a single settings screen with its sections, fields and values", "operationId": "get_settings_screen_get", "parameters": [ { "name": "lang", "in": "query", "description": "Language of the texts, de or en", "required": false, "schema": { "type": "string" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the screen the user may open" } } } }, "\/api\/settings\/universal_list_definitions": { "get": { "tags": [ "Settings \/ Universal lists" ], "summary": "Get the definitions of all universal lists, with the buttons the user may use", "operationId": "get_universal_list_definition_cget", "responses": { "200": { "description": "Returns the version of the format and the definitions per entity type" } } } }, "\/api\/settings\/updatable_settings": { "get": { "tags": [ "Settings \/ Settings" ], "summary": "This method will get all Setting Objects", "operationId": "get_updatable_setting_cget", "parameters": [ { "name": "searchString", "in": "query", "description": "Case-insensitive substring search in ID, German and English name and description, before pagination.", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/settings\/external_hr\/status": { "get": { "tags": [ "TimeTracking \/ ExternalHr" ], "summary": "Current state of the external HR integration: selected provider, capability\nmatrix, per-area toggles and last sync results (cursor, counts, conflicts).", "operationId": "get_external_hr_status", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/settings\/external_hr\/test_connection": { "post": { "tags": [ "TimeTracking \/ ExternalHr" ], "summary": "Test the provider connection with the currently stored credentials. Returns\nok\/error plus the provider's absence types \/ time-off policies for the mapping UI.", "operationId": "post_external_hr_test_connection", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/settings\/external_hr\/sync": { "post": { "tags": [ "TimeTracking \/ ExternalHr" ], "summary": "Trigger a sync run now (creates a one-time cron task processed by the cron runner).", "operationId": "post_external_hr_sync", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/settings\/buchhaltungsbutler\/status": { "get": { "tags": [ "Settings \/ BuchhaltungsButler" ], "summary": "Returns the BuchhaltungsButler integration status", "operationId": "get_settings_buchhaltungsbutler_status", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the BuchhaltungsButler integration status", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BuchhaltungsButlerStatus" } } } } } } }, "\/api\/settings\/buchhaltungsbutler\/test_connection": { "post": { "tags": [ "Settings \/ BuchhaltungsButler" ], "summary": "Tests the BuchhaltungsButler API connection with the stored credentials", "operationId": "post_settings_buchhaltungsbutler_test_connection", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Tests the BuchhaltungsButler API connection", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/BuchhaltungsButlerStatus" } } } } } } }, "\/api\/settings\/buchhaltungsbutler\/sync": { "post": { "tags": [ "Settings \/ BuchhaltungsButler" ], "summary": "Triggers a one-shot BuchhaltungsButler pull sync (\"Sync now\")", "operationId": "post_settings_buchhaltungsbutler_sync", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Triggers a one-shot BuchhaltungsButler pull sync", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Success" } } } } } } }, "\/api\/settings\/ui_field": { "get": { "tags": [ "Settings \/ AdditionalUiField" ], "summary": "Returns a list of all AdditionalUiField", "operationId": "get_settings_additional_ui_field_cget", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "entityType", "in": "query", "description": "Entity the field is added to, for example Person. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "infoMode", "in": "query", "description": "Display mode of the info text of the field. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "fieldGroup", "in": "query", "description": "Group the field is shown in on the detail page. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "fieldType", "in": "query", "description": "Input type of the field, for example text, number or date. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "fieldName", "in": "query", "description": "Technical name of the field. Used as the key in the API. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "fieldOrder", "in": "query", "description": "Sort order of the field inside its group. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all AdditionalUiField", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AdditionalUiField" } } } } } } }, "post": { "tags": [ "Settings \/ AdditionalUiField" ], "summary": "Add a new AdditionalUiField", "operationId": "post_settings_additional_ui_field_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AdditionalUiField" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new AdditionalUiField", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AdditionalUiField" } } } } } } }, "\/api\/settings\/ui_field\/{identifier}": { "get": { "tags": [ "Settings \/ AdditionalUiField" ], "summary": "Returns a single AdditionalUiField entry.", "operationId": "get_settings_additional_ui_field_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single AdditionalUiField", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AdditionalUiField" } } } } } }, "put": { "tags": [ "Settings \/ AdditionalUiField" ], "summary": "Updates an existing AdditionalUiField entry.", "operationId": "put_settings_additional_ui_field_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AdditionalUiField" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single AdditionalUiField", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AdditionalUiField" } } } } } }, "patch": { "tags": [ "Settings \/ AdditionalUiField" ], "summary": "Updates an existing AdditionalUiField entry.", "operationId": "patch_settings_additional_ui_field_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AdditionalUiField" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single AdditionalUiField", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AdditionalUiField" } } } } } } }, "\/api\/settings\/ui_filter": { "get": { "tags": [ "Settings \/ AdditionalUiFilter" ], "summary": "Returns a list of all AdditionalUiFilter", "operationId": "get_settings_additional_ui_filter_cget", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "entityType", "in": "query", "description": "Entity the filter is added to, for example Person. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "infoMode", "in": "query", "description": "Display mode of the info text of the filter. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "filterGroup", "in": "query", "description": "Group the filter is shown in. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "filterType", "in": "query", "description": "Type of the filter, for example single value or range. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "filterOrder", "in": "query", "description": "Sort order of the filter inside its group. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all AdditionalUiFilter", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AdditionalUiFilter" } } } } } } }, "post": { "tags": [ "Settings \/ AdditionalUiFilter" ], "summary": "Add a new AdditionalUiFilter", "operationId": "post_settings_additional_ui_filter_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AdditionalUiFilter" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new AdditionalUiFilter", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AdditionalUiFilter" } } } } } } }, "\/api\/settings\/ui_filter\/{identifier}": { "get": { "tags": [ "Settings \/ AdditionalUiFilter" ], "summary": "Returns a single AdditionalUiFilter entry.", "operationId": "get_settings_additional_ui_filter_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single AdditionalUiFilter", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AdditionalUiFilter" } } } } } }, "put": { "tags": [ "Settings \/ AdditionalUiFilter" ], "summary": "Updates an existing AdditionalUiFilter entry.", "operationId": "put_settings_additional_ui_filter_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AdditionalUiFilter" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single AdditionalUiFilter", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AdditionalUiFilter" } } } } } }, "patch": { "tags": [ "Settings \/ AdditionalUiFilter" ], "summary": "Updates an existing AdditionalUiFilter entry.", "operationId": "patch_settings_additional_ui_filter_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/AdditionalUiFilter" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single AdditionalUiFilter", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AdditionalUiFilter" } } } } } } }, "\/api\/settings\/disabled_ui_function": { "get": { "tags": [ "Settings \/ DisabledUiFunction" ], "summary": "Returns a list of all DisabledUiFunction", "operationId": "get_settings_disabled_ui_function_cget", "parameters": [ { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "entityType", "in": "query", "description": "Entity the function is hidden for, for example Person. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "infoMode", "in": "query", "description": "Display mode of the info text of the function. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "functionType", "in": "query", "description": "Type of the hidden function, for example button or menu. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "functionName", "in": "query", "description": "Technical name of the function. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "functionScope", "in": "query", "description": "Access scope the function belongs to. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all DisabledUiFunction", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/DisabledUiFunction" } } } } } } } }, "\/api\/settings\/disabled_ui_function\/{identifier}": { "get": { "tags": [ "Settings \/ DisabledUiFunction" ], "summary": "Returns a single DisabledUiFunction entry.", "operationId": "get_settings_disabled_ui_function_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single DisabledUiFunction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DisabledUiFunction" } } } } } }, "put": { "tags": [ "Settings \/ DisabledUiFunction" ], "summary": "Updates an existing DisabledUiFunction entry.", "operationId": "put_settings_disabled_ui_function_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/DisabledUiFunction" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single DisabledUiFunction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DisabledUiFunction" } } } } } }, "patch": { "tags": [ "Settings \/ DisabledUiFunction" ], "summary": "Updates an existing DisabledUiFunction entry.", "operationId": "patch_settings_disabled_ui_function_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/DisabledUiFunction" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update single DisabledUiFunction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/DisabledUiFunction" } } } } } } }, "\/api\/settings\/cron_tasks": { "get": { "tags": [ "Settings \/ CronTask" ], "summary": "Returns a list of all CronTasks", "operationId": "get_settings_cron_task_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "command", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "running", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "done", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "deleteAfterDone", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of all CronTasks", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CronTask" } } } } } } }, "post": { "tags": [ "Settings \/ CronTask" ], "summary": "Add a new CronTask", "operationId": "post_settings_cron_task_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CronTask" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new CronTask", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CronTask" } } } } } } }, "\/api\/settings\/cron_tasks\/{identifier}": { "get": { "tags": [ "Settings \/ CronTask" ], "summary": "Returns a single CronTask entry.", "operationId": "get_settings_cron_task_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return single CronTask", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CronTask" } } } } } }, "delete": { "tags": [ "Settings \/ CronTask" ], "summary": "Delete a CronTask", "operationId": "delete_settings_cron_task_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/settings\/maintenance_commands": { "get": { "tags": [ "Settings \/ MaintenanceCommand" ], "summary": "Returns the maintenance commands that may be started from the interface, including the\noptions each of them accepts.", "operationId": "get_settings_maintenance_command_cget", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns all available maintenance commands", "content": { "application\/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "section": { "type": "string" }, "applyOption": { "type": "string", "nullable": true }, "options": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "required": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "choices": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Settings \/ MaintenanceCommand" ], "summary": "Queues a maintenance command as a CronTask and returns that task. The command output shows\nup in the task's result once the cron has run it.", "operationId": "post_settings_maintenance_command_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "key": { "description": "Command key from the list endpoint", "type": "string" }, "options": { "description": "Option name => value, validated against the command definition", "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The queued CronTask", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CronTask" } } } } } } }, "\/api\/settings\/home_widget_default": { "get": { "tags": [ "Settings \/ CustomerAppHomeWidgetDefault" ], "summary": "Returns a list of all CustomerAppHomeWidgetDefault entries", "operationId": "get_settings_home_widget_default_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "Settings \/ CustomerAppHomeWidgetDefault" ], "summary": "Add a new CustomerAppHomeWidgetDefault", "operationId": "post_settings_home_widget_default_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerAppHomeWidgetDefault" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/settings\/home_widget_default\/{identifier}": { "get": { "tags": [ "Settings \/ CustomerAppHomeWidgetDefault" ], "summary": "Returns a single CustomerAppHomeWidgetDefault entry.", "operationId": "get_settings_home_widget_default_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "Settings \/ CustomerAppHomeWidgetDefault" ], "summary": "Updates an existing CustomerAppHomeWidgetDefault entry.", "operationId": "put_settings_home_widget_default_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerAppHomeWidgetDefault" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "Settings \/ CustomerAppHomeWidgetDefault" ], "summary": "Delete a CustomerAppHomeWidgetDefault (soft delete)", "operationId": "delete_settings_home_widget_default_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Settings \/ CustomerAppHomeWidgetDefault" ], "summary": "Updates an existing CustomerAppHomeWidgetDefault entry.", "operationId": "patch_settings_home_widget_default_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerAppHomeWidgetDefault" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/settings\/customer_app_menu_group": { "get": { "tags": [ "Settings \/ CustomerAppMenuGroup" ], "summary": "Returns a list of all CustomerAppMenuGroup entries", "operationId": "get_settings_customer_app_menu_group_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "Settings \/ CustomerAppMenuGroup" ], "summary": "Add a new CustomerAppMenuGroup", "operationId": "post_settings_customer_app_menu_group_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerAppMenuGroup" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/settings\/customer_app_menu_group\/{identifier}": { "get": { "tags": [ "Settings \/ CustomerAppMenuGroup" ], "summary": "Returns a single CustomerAppMenuGroup entry.", "operationId": "get_settings_customer_app_menu_group_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "Settings \/ CustomerAppMenuGroup" ], "summary": "Updates an existing CustomerAppMenuGroup entry.", "operationId": "put_settings_customer_app_menu_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerAppMenuGroup" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "Settings \/ CustomerAppMenuGroup" ], "summary": "Delete a CustomerAppMenuGroup (soft delete)", "operationId": "delete_settings_customer_app_menu_group_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Settings \/ CustomerAppMenuGroup" ], "summary": "Updates an existing CustomerAppMenuGroup entry.", "operationId": "patch_settings_customer_app_menu_group_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerAppMenuGroup" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/settings\/customer_app_menu_item": { "get": { "tags": [ "Settings \/ CustomerAppMenuItem" ], "summary": "Returns a list of all CustomerAppMenuItem entries", "operationId": "get_settings_customer_app_menu_item_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "Settings \/ CustomerAppMenuItem" ], "summary": "Add a new CustomerAppMenuItem", "operationId": "post_settings_customer_app_menu_item_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerAppMenuItem" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/settings\/customer_app_menu_item\/{identifier}": { "get": { "tags": [ "Settings \/ CustomerAppMenuItem" ], "summary": "Returns a single CustomerAppMenuItem entry.", "operationId": "get_settings_customer_app_menu_item_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "Settings \/ CustomerAppMenuItem" ], "summary": "Updates an existing CustomerAppMenuItem entry.", "operationId": "put_settings_customer_app_menu_item_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerAppMenuItem" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "Settings \/ CustomerAppMenuItem" ], "summary": "Delete a CustomerAppMenuItem (soft delete)", "operationId": "delete_settings_customer_app_menu_item_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Settings \/ CustomerAppMenuItem" ], "summary": "Updates an existing CustomerAppMenuItem entry.", "operationId": "patch_settings_customer_app_menu_item_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/CustomerAppMenuItem" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/opendata\/mcp_access_filter_catalog": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "All MCP tools and API routes (PATCH\/POST of api_patch\/api_post) a filter can allow (for the management UI). alwaysAllowed tools are never\nfiltered. Texts follow ?lang= \/ Accept-Language.", "operationId": "get_od_mcp_access_filter_catalog", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "tools: [{name, title, description, readOnly, alwaysAllowed}], api_routes: [{route, method, path, entity, summary}]" } } } }, "\/api\/opendata\/mcp_access_filter": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Returns the MCP tool filters of the own API access tokens (filter with ?apiAccessToken=)", "operationId": "get_od_mcp_access_filter_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the MCP tool filters of the own API access tokens", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/McpAccessFilter" } } } } } } }, "post": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Adds the MCP tool filter of an own API access token (one filter per token).", "description": "allowed_tools \/ allowed_api_routes: lists of names from the catalog, null = no limit.", "operationId": "post_od_mcp_access_filter_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/McpAccessFilter" } }, "type": "object" } } } }, "responses": { "200": { "description": "Adds the MCP tool filter of an API access token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/McpAccessFilter" } } } } } } }, "\/api\/opendata\/mcp_access_filter\/{identifier}": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Returns a single MCP tool filter of an own API access token", "operationId": "get_od_mcp_access_filter_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MCP tool filter", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/McpAccessFilter" } } } } } }, "put": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Changes the MCP tool filter of an own API access token (PATCH: only the fields sent)", "operationId": "put_od_mcp_access_filter_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/McpAccessFilter" } }, "type": "object" } } } }, "responses": { "200": { "description": "Changes the MCP tool filter of an API access token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/McpAccessFilter" } } } } } }, "delete": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Removes the MCP tool filter of an own API access token (the token may then use all tools again)", "operationId": "delete_od_mcp_access_filter_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Removes the MCP tool filter of an API access token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/McpAccessFilter" } } } } } }, "patch": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Changes the MCP tool filter of an own API access token (PATCH: only the fields sent)", "operationId": "patch_od_mcp_access_filter_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/McpAccessFilter" } }, "type": "object" } } } }, "responses": { "200": { "description": "Changes the MCP tool filter of an API access token", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/McpAccessFilter" } } } } } } }, "\/api\/opendata\/mcp_approval_request": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Returns the visible approval requests, newest first (?status=pending,failed&actionType=&page=&pageSize=).", "description": "Response headers X-IW-MAX-RESULTS \/ X-IW-MAX-PAGES carry the totals.", "operationId": "get_od_mcp_approval_request_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the visible approval requests of AI agents", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/McpApprovalRequest" } } } } } } } }, "\/api\/opendata\/mcp_approval_request\/{identifier}": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Returns one approval request with preview, payload, decision and result", "operationId": "get_od_mcp_approval_request_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns one approval request", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/McpApprovalRequest" } } } } } } }, "\/api\/opendata\/mcp_approval_request\/{identifier}\/approve": { "post": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Approves the request and runs the action with the caller's rights. Only for people logged in to the ERP\n(x-session-token header). Body: {\"comment\": \"...\"} (optional). The response is the request with status\nexecuted (result) or failed (error_message); a failed action saved nothing.", "operationId": "post_od_mcp_approval_request_approve", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Approves and runs an approval request", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/McpApprovalRequest" } } } } } } }, "\/api\/opendata\/mcp_approval_request\/{identifier}\/reject": { "post": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Rejects the request; nothing runs. Only for people logged in to the ERP (x-session-token header).", "description": "Body: {\"comment\": \"...\"} (optional, the agent sees it).", "operationId": "post_od_mcp_approval_request_reject", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Rejects an approval request", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/McpApprovalRequest" } } } } } } }, "\/api\/opendata\/mcp_approval_request\/{identifier}\/cancel": { "post": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Withdraws a pending request; only the login (user) that proposed it.", "operationId": "post_od_mcp_approval_request_cancel", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Withdraws an own pending approval request", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/McpApprovalRequest" } } } } } } }, "\/api\/opendata\/mcp_tool_call_log": { "get": { "tags": [ "Login \/ JWT ApiAccess" ], "summary": "Returns the MCP tool calls, newest first (?toolName=&userId=&outcome=ok|error|denied&approvalRequest=&from=&to=&page=&pageSize=).", "description": "Response headers X-IW-MAX-RESULTS \/ X-IW-MAX-PAGES carry the totals.", "operationId": "get_od_mcp_tool_call_log_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the audit trail of the MCP server", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/McpToolCallLog" } } } } } } } }, "\/api\/billing\/travel\/expense_reports": { "get": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Returns a list of all TravelExpenseReport", "operationId": "get_get_travel_expense_reports", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "reportNumber", "in": "query", "description": "Report number (e.g., TER2025-00001) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "submitter", "in": "query", "description": "Person submitting the expense report | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "submitterUser", "in": "query", "description": "User account of submitter | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "approver", "in": "query", "description": "Approver\/Reviewer | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Company\/Employer for billing | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "Related project (optional) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "invoice", "in": "query", "description": "Reference to created Invoice (for payment) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "purpose", "in": "query", "description": "Travel purpose\/reason | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "destination", "in": "query", "description": "Travel destination | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "destinationCountry", "in": "query", "description": "Destination country (for international per diem rates) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "travelStart", "in": "query", "description": "Travel start date\/time | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "travelEnd", "in": "query", "description": "Travel end date\/time | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "previousStatus", "in": "query", "description": "Previous status (for workflow tracking) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "statusUpdated", "in": "query", "description": "Date when status was last updated | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "submittedAt", "in": "query", "description": "Submission date | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "approvedAt", "in": "query", "description": "Approval date | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "paidAt", "in": "query", "description": "Payment date | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "rejectionReason", "in": "query", "description": "Rejection reason | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "internalNotes", "in": "query", "description": "Internal notes | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "totalPerDiem", "in": "query", "description": "Total Verpflegungsmehraufwand (per diem) | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "totalTravelCosts", "in": "query", "description": "Total Fahrtkosten (travel costs) | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "totalAccommodation", "in": "query", "description": "Total Uebernachtungskosten (accommodation) | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "totalIncidentals", "in": "query", "description": "Total Nebenkosten (incidental expenses) | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "totalAmount", "in": "query", "description": "Grand total (all expenses) | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "taxFreeAmount", "in": "query", "description": "Tax-free portion (steuerfreier Anteil) | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "taxableAmount", "in": "query", "description": "Taxable portion (steuerpflichtiger Anteil) | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "currency", "in": "query", "description": "Currency | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "fullDaysCount", "in": "query", "description": "Number of full days (24h) for per diem | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "partialDaysCount", "in": "query", "description": "Number of partial days (arrival\/departure) | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "breakfastProvidedCount", "in": "query", "description": "Breakfast provided count (for deduction) | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "lunchProvidedCount", "in": "query", "description": "Lunch provided count (for deduction) | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "dinnerProvidedCount", "in": "query", "description": "Dinner provided count (for deduction) | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "mealDeductionAmount", "in": "query", "description": "Total meal deduction amount | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "searchString", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of TravelExpenseReport objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TravelExpenseReport" } } } } } } }, "post": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Create a new TravelExpenseReport", "operationId": "post_post_travel_expense_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TravelExpenseReport2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a new TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}": { "get": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Get a single TravelExpenseReport", "operationId": "get_get_travel_expense_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } }, "put": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Update a TravelExpenseReport", "operationId": "put_put_travel_expense_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TravelExpenseReport2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } }, "delete": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Delete a TravelExpenseReport", "operationId": "delete_delete_travel_expense_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Update a TravelExpenseReport", "operationId": "patch_put_travel_expense_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/TravelExpenseReport2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/submit": { "post": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Submit report for approval", "operationId": "post_post_travel_expense_report_submit", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Submit TravelExpenseReport for approval", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/approve": { "post": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Approve the report", "operationId": "post_post_travel_expense_report_approve", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Approve a TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/reject": { "post": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Reject the report with reason", "operationId": "post_post_travel_expense_report_reject", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reject a TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/pay": { "post": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Mark as paid", "operationId": "post_post_travel_expense_report_pay", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Mark TravelExpenseReport as paid", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/cancel": { "post": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Cancel the report", "operationId": "post_post_travel_expense_report_cancel", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Cancel a TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/reopen": { "post": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Reopen rejected report", "operationId": "post_post_travel_expense_report_reopen", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Reopen a rejected TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/items": { "post": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Add expense item to report", "operationId": "post_post_travel_expense_report_item", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Add expense item to TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/items\/{itemId}": { "put": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Update expense item", "operationId": "put_put_travel_expense_report_item", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update expense item in TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } }, "delete": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Remove expense item", "operationId": "delete_delete_travel_expense_report_item", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Remove expense item from TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } }, "patch": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Update expense item", "operationId": "patch_put_travel_expense_report_item", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update expense item in TravelExpenseReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/calculate": { "post": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Recalculate totals", "operationId": "post_post_travel_expense_report_calculate", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Recalculate TravelExpenseReport totals", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } } } } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/pdf": { "get": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Generate PDF export", "operationId": "get_get_travel_expense_report_pdf", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/billing\/travel\/expense_reports\/{identifier}\/create_invoice": { "post": { "tags": [ "Billing \/ TravelExpenseReport" ], "summary": "Create Invoice from approved report", "operationId": "post_post_travel_expense_report_create_invoice", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/billing\/travel\/expense_types": { "get": { "tags": [ "Billing \/ TravelExpenseType" ], "summary": "Returns a list of all TravelExpenseType", "operationId": "get_get_travel_expense_types", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "typeKey", "in": "query", "description": "Internal type identifier (e.g., KM_PAUSCHALE_PKW, HOTEL) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Display name | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Description | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Parent expense category | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "defaultRate", "in": "query", "description": "Default rate (e.g., km rate 0.30, per diem rate 28.00) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "rateUnit", "in": "query", "description": "Unit for the rate (EUR, EUR\/km, EUR\/Tag, etc.) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isTaxFreeDefault", "in": "query", "description": "Is this type tax-free by default (steuerfrei)? | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "receiptRequired", "in": "query", "description": "Is receipt required for this type? | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "maxAmount", "in": "query", "description": "Maximum allowed amount per item (for validation, null = no limit) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Is this type active\/available for selection | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "sortOrder", "in": "query", "description": "Sort order for display | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of TravelExpenseType objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TravelExpenseType" } } } } } } } }, "\/api\/billing\/travel\/expense_types\/{identifier}": { "get": { "tags": [ "Billing \/ TravelExpenseType" ], "summary": "Get a single TravelExpenseType", "operationId": "get_get_travel_expense_type", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single TravelExpenseType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseType" } } } } } }, "delete": { "tags": [ "Billing \/ TravelExpenseType" ], "summary": "Delete a TravelExpenseType (soft delete via isActive = false)", "operationId": "delete_delete_travel_expense_type", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/billing\/travel\/country_rates": { "get": { "tags": [ "Billing \/ TravelExpenseCountryRate" ], "summary": "Returns a list of all TravelExpenseCountryRate", "operationId": "get_get_travel_expense_country_rates", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "countryCode", "in": "query", "description": "ISO 3166-1 alpha-2 country code (e.g., DE, AT, FR, US) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "countryName", "in": "query", "description": "Country name for display | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "fullDayRate", "in": "query", "description": "Per diem rate for full day (24 hours) | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "partialDayRate", "in": "query", "description": "Per diem rate for partial day (>8h or arrival\/departure) | Requires access right: SCOPE", "required": false, "schema": { "type": "number" } }, { "name": "accommodationRate", "in": "query", "description": "Optional accommodation rate limit (Uebernachtungspauschale) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "breakfastDeduction", "in": "query", "description": "Breakfast deduction amount (if applicable for this country) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "lunchDeduction", "in": "query", "description": "Lunch deduction amount | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "dinnerDeduction", "in": "query", "description": "Dinner deduction amount | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency for the rates (usually EUR) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "validFrom", "in": "query", "description": "Date from which this rate is valid | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "validUntil", "in": "query", "description": "Date until which this rate is valid (null = indefinitely) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Is this rate active\/available | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "notes", "in": "query", "description": "Notes about the rate (e.g., source, special rules) | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of TravelExpenseCountryRate objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TravelExpenseCountryRate" } } } } } } } }, "\/api\/billing\/travel\/country_rates\/{identifier}": { "get": { "tags": [ "Billing \/ TravelExpenseCountryRate" ], "summary": "Get a single TravelExpenseCountryRate", "operationId": "get_get_travel_expense_country_rate", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single TravelExpenseCountryRate", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TravelExpenseCountryRate" } } } } } }, "delete": { "tags": [ "Billing \/ TravelExpenseCountryRate" ], "summary": "Delete a TravelExpenseCountryRate (soft delete via isActive = false)", "operationId": "delete_delete_travel_expense_country_rate", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/product\/inventory\/reports": { "get": { "tags": [ "Billing \/ InventoryReport" ], "summary": "Returns a list of InventoryReport objects.", "description": "When import_legacy=true, imports all reports and items from the legacy ECS database.", "operationId": "get_get_inventory_reports", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "completed", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of InventoryReport objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryReport" } } } } } } }, "post": { "tags": [ "Billing \/ InventoryReport" ], "summary": "Creates a single InventoryReport", "operationId": "post_post_inventory_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/InventoryReport2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single InventoryReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryReport" } } } } } } }, "\/api\/product\/inventory\/reports\/{identifier}": { "get": { "tags": [ "Billing \/ InventoryReport" ], "summary": "Returns a single InventoryReport with the given id", "operationId": "get_get_inventory_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single InventoryReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryReport" } } } } } }, "put": { "tags": [ "Billing \/ InventoryReport" ], "summary": "Updates a single InventoryReport.", "description": "When completed is set to true, triggers write-back to legacy ECS database if configured.", "operationId": "put_put_inventory_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/InventoryReport2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single InventoryReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryReport" } } } } } }, "patch": { "tags": [ "Billing \/ InventoryReport" ], "summary": "Updates a single InventoryReport.", "description": "When completed is set to true, triggers write-back to legacy ECS database if configured.", "operationId": "patch_put_inventory_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/InventoryReport2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single InventoryReport", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryReport" } } } } } } }, "\/api\/product\/inventory\/report_items": { "get": { "tags": [ "Billing \/ InventoryReportItem" ], "summary": "Returns a list of InventoryReportItem objects", "operationId": "get_get_inventory_report_items", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "inventoryReport", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "product", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "storageLocation", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "productName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sku", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "barcode", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "manufacturer", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "storageLocationName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isDefaultLocation", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "targetCount", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "currentCount", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "position", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of InventoryReportItem objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/InventoryReportItem" } } } } } } }, "post": { "tags": [ "Billing \/ InventoryReportItem" ], "summary": "Creates a single InventoryReportItem", "operationId": "post_post_inventory_report_item", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/InventoryReportItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Creates a single InventoryReportItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryReportItem" } } } } } } }, "\/api\/product\/inventory\/report_items\/{identifier}": { "get": { "tags": [ "Billing \/ InventoryReportItem" ], "summary": "Returns a single InventoryReportItem with the given id", "operationId": "get_get_inventory_report_item", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single InventoryReportItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryReportItem" } } } } } }, "put": { "tags": [ "Billing \/ InventoryReportItem" ], "summary": "Updates a single InventoryReportItem", "operationId": "put_put_inventory_report_item", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/InventoryReportItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single InventoryReportItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryReportItem" } } } } } }, "patch": { "tags": [ "Billing \/ InventoryReportItem" ], "summary": "Updates a single InventoryReportItem", "operationId": "patch_put_inventory_report_item", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/InventoryReportItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updates a single InventoryReportItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/InventoryReportItem" } } } } } } }, "\/api\/product\/inventory\/storage_locations": { "get": { "tags": [ "Billing \/ StorageLocation" ], "summary": "This method will get all StorageLocation Objects", "operationId": "get_get_storage_locations", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of StorageLocation objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/StorageLocation" } } } } } } }, "post": { "tags": [ "Billing \/ StorageLocation" ], "summary": "Creates a single StorageLocation", "operationId": "post_post_storage_location", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Creates a single StorageLocation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StorageLocation" } } } } } } }, "\/api\/product\/inventory\/storage_locations\/{identifier}": { "get": { "tags": [ "Billing \/ StorageLocation" ], "summary": "This method will get a single StorageLocation Object with the given id", "operationId": "get_get_storage_location", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single StorageLocation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StorageLocation" } } } } } }, "put": { "tags": [ "Billing \/ StorageLocation" ], "summary": "This method will update a StorageLocation Object", "operationId": "put_put_storage_location", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a StorageLocation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StorageLocation" } } } } } }, "patch": { "tags": [ "Billing \/ StorageLocation" ], "summary": "This method will update a StorageLocation Object", "operationId": "patch_put_storage_location", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update a StorageLocation", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StorageLocation" } } } } } } }, "\/api\/hbci\/credentials": { "get": { "tags": [ "Billing \/ HBCI" ], "summary": "Get all HBCI credentials", "operationId": "get_hbci_credentials_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of HBCI credentials", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HbciCredential" } } } } } } }, "post": { "tags": [ "Billing \/ HBCI" ], "summary": "Create new HBCI credential", "operationId": "post_hbci_credentials_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/HbciCredential2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a new HBCI credential", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/HbciCredential" } } } } } } }, "\/api\/hbci\/credentials\/{identifier}": { "get": { "tags": [ "Billing \/ HBCI" ], "summary": "Get single HBCI credential", "operationId": "get_hbci_credentials_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns a single HBCI credential", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/HbciCredential" } } } } } }, "put": { "tags": [ "Billing \/ HBCI" ], "summary": "Update HBCI credential", "operationId": "put_hbci_credentials_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/HbciCredential2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update an HBCI credential", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/HbciCredential" } } } } } }, "delete": { "tags": [ "Billing \/ HBCI" ], "summary": "Delete HBCI credential (soft delete)", "operationId": "delete_hbci_credentials_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/hbci\/credentials\/{identifier}\/tan-modes": { "get": { "tags": [ "Billing \/ HBCI" ], "summary": "Get available TAN modes for credential", "operationId": "get_hbci_credentials_tan_modes", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/hbci\/credentials\/{identifier}\/tan-modes\/{tanModeId}\/media": { "get": { "tags": [ "Billing \/ HBCI" ], "summary": "Get available TAN media for a TAN mode", "operationId": "get_hbci_credentials_tan_media", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "tanModeId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/hbci\/credentials\/{identifier}\/login": { "post": { "tags": [ "Billing \/ HBCI" ], "summary": "Test login with credential (returns accounts)", "operationId": "post_hbci_credentials_login", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/hbci\/credentials\/{identifier}\/fetch-statements": { "post": { "tags": [ "Billing \/ HBCI" ], "summary": "Fetch statements for credential", "operationId": "post_hbci_credentials_fetch_statements", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/hbci\/sessions\/{sessionToken}\/submit-tan": { "post": { "tags": [ "Billing \/ HBCI" ], "summary": "Submit TAN for pending session", "operationId": "post_hbci_sessions_submit_tan", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "sessionToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/hbci\/sessions\/{sessionToken}\/check-decoupled": { "get": { "tags": [ "Billing \/ HBCI" ], "summary": "Check decoupled authentication status", "operationId": "get_hbci_sessions_check_decoupled", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "sessionToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/hbci\/sessions\/{sessionToken}": { "get": { "tags": [ "Billing \/ HBCI" ], "summary": "Get session status", "operationId": "get_hbci_sessions_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "sessionToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns HBCI session status", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/HbciSession" } } } } } } }, "\/api\/hbci\/payment_submission": { "get": { "tags": [ "Billing \/ HBCI" ], "summary": "List HBCI payment submissions (newest first)", "operationId": "get_hbci_payment_submission_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "batchKey", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "executionName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "billingPaymentProfile", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "hbciCredential", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requestedDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of HBCI payment submissions", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HbciPaymentSubmission" } } } } } } } }, "\/api\/hbci\/payment_submission\/action\/prepare": { "post": { "tags": [ "Billing \/ HBCI" ], "summary": "Prepare the submission of a SEPA run (step 1 of the four-eyes principle). Nothing is sent to the bank.", "description": "Body: name (run name), payment_profile (id, optional), type (direct_debit|donation_direct_debit|credit_transfer,\noptional - derived from the run name), credential (HbciCredential id, optional), requested_date (Y-m-d, optional)", "operationId": "post_hbci_payment_submission_prepare", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "batchKey", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "executionName", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "billingPaymentProfile", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "hbciCredential", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "requestedDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "The prepared drafts, one per payment group", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HbciPaymentSubmission" } } } } } } } }, "\/api\/hbci\/payment_submission\/{identifier}": { "get": { "tags": [ "Billing \/ HBCI" ], "summary": "Single HBCI payment submission with the full review (all transactions and findings)", "operationId": "get_hbci_payment_submission_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns a single HBCI payment submission", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/HbciPaymentSubmission" } } } } } } }, "\/api\/hbci\/payment_submission\/{identifier}\/xml": { "get": { "tags": [ "Billing \/ HBCI" ], "summary": "The pain XML exactly as it is (or was) sent to the bank", "operationId": "get_hbci_payment_submission_xml", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "pain.008 \/ pain.001 XML file" } } } }, "\/api\/hbci\/payment_submission\/{identifier}\/approve": { "post": { "tags": [ "Billing \/ HBCI" ], "summary": "Approve a prepared submission and send it to the bank (step 2, by a second person)", "description": "Body: pain_xml_hash (the hash shown in the review), confirmed (true)\nReturns the bank step result (needs_tan, session_token, ...) and the updated submission.", "operationId": "post_hbci_payment_submission_approve", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Result of the bank dialog and the submission" } } } }, "\/api\/hbci\/payment_submission\/{identifier}\/cancel": { "post": { "tags": [ "Billing \/ HBCI" ], "summary": "Withdraw a draft or abort the TAN entry", "operationId": "post_hbci_payment_submission_cancel", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "The cancelled submission", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/HbciPaymentSubmission" } } } } } } }, "\/api\/hbci\/payment_submission\/{identifier}\/resolve": { "post": { "tags": [ "Billing \/ HBCI" ], "summary": "Resolve a submission whose outcome is unknown after checking the online banking", "description": "Body: resolution (executed|not_executed), note (optional)", "operationId": "post_hbci_payment_submission_resolve", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "The resolved submission", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/HbciPaymentSubmission" } } } } } } }, "\/api\/media\/social_profile": { "get": { "tags": [ "Media \/ Social Profiles" ], "summary": "Returns a list of social profiles", "operationId": "get_media_social_profile_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "Media \/ Social Profiles" ], "summary": "Admin creates a social profile", "operationId": "post_media_social_profile_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialProfile" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a new social profile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialProfile2" } } } } } } }, "\/api\/media\/social_profile\/user": { "get": { "tags": [ "Media \/ Social Profiles" ], "summary": "Returns the caller's own social profile, 404 if they have none yet", "description": "Lets a client decide between offering \"create profile\" and \"edit profile\" without\nknowing the profile id. Available whether or not the social network is switched on,\nlike creating and updating the own profile.", "operationId": "get_media_social_profile_user_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the caller's own social profile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialProfile2" } } } } } }, "post": { "tags": [ "Media \/ Social Profiles" ], "summary": "User creates their own social profile", "operationId": "post_media_social_profile_user_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialProfile" } }, "type": "object" } } } }, "responses": { "200": { "description": "User creates their own social profile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialProfile2" } } } } } } }, "\/api\/media\/social_profile\/{identifier}": { "get": { "tags": [ "Media \/ Social Profiles" ], "summary": "Returns a single social profile", "operationId": "get_media_social_profile_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "Media \/ Social Profiles" ], "summary": "Admin updates a social profile", "operationId": "put_media_social_profile_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialProfile" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a social profile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialProfile2" } } } } } }, "patch": { "tags": [ "Media \/ Social Profiles" ], "summary": "Admin updates a social profile", "operationId": "patch_media_social_profile_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialProfile" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a social profile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialProfile2" } } } } } } }, "\/api\/media\/social_profile\/user\/{identifier}": { "put": { "tags": [ "Media \/ Social Profiles" ], "summary": "User updates their own social profile", "operationId": "put_media_social_profile_user_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialProfile" } }, "type": "object" } } } }, "responses": { "200": { "description": "User updates their own social profile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialProfile2" } } } } } }, "patch": { "tags": [ "Media \/ Social Profiles" ], "summary": "User updates their own social profile", "operationId": "patch_media_social_profile_user_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialProfile" } }, "type": "object" } } } }, "responses": { "200": { "description": "User updates their own social profile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialProfile2" } } } } } } }, "\/api\/media\/social\/status": { "get": { "tags": [ "Media \/ Social Posts" ], "summary": "Returns the social network status for the current session.", "description": "Includes feature enablement, posting capabilities, profile status,\nand global profile existence.", "operationId": "get_media_social_status", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/social_post": { "get": { "tags": [ "Media \/ Social Posts" ], "summary": "Returns a list of social posts (three-tier visibility)", "operationId": "get_media_social_post_cget", "parameters": [ { "name": "headline", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBooking", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "newsArticle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "visibilityType", "in": "query", "description": "Requires access right: LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "moderationStatus", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaSocialPost objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaSocialPost" } } } } } } }, "post": { "tags": [ "Media \/ Social Posts" ], "summary": "Admin creates a social post", "operationId": "post_media_social_post_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPost2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Admin creates a social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPost" } } } } } } }, "\/api\/media\/social_post\/feed\/favorites": { "get": { "tags": [ "Media \/ Social Posts" ], "summary": "Returns a feed of social posts matching the current user's favorites\n(favorite events or favorite unified categories), respecting three-tier visibility.", "operationId": "get_media_social_post_favorites_feed", "parameters": [ { "name": "headline", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBooking", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "newsArticle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "visibilityType", "in": "query", "description": "Requires access right: LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "moderationStatus", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a feed of favorite-related social posts", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaSocialPost3" } } } } } } } }, "\/api\/media\/social_post\/feed\/category\/{ucatId}": { "get": { "tags": [ "Media \/ Social Posts" ], "summary": "Returns a feed of social posts filtered by a unified category (three-tier visibility).", "operationId": "get_media_social_post_category_feed", "parameters": [ { "name": "headline", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBooking", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "newsArticle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "visibilityType", "in": "query", "description": "Requires access right: LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "moderationStatus", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "ucatId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns a feed of MediaSocialPost objects by category", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaSocialPost3" } } } } } } } }, "\/api\/media\/social_post\/feed\/profile\/{profileIdentifier}": { "get": { "tags": [ "Media \/ Social Posts" ], "summary": "Returns a feed of social posts for a specific user profile (three-tier visibility).", "operationId": "get_media_social_post_profile_feed", "parameters": [ { "name": "headline", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBooking", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "baseBookable", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "newsArticle", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "visibilityType", "in": "query", "description": "Requires access right: LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "moderationStatus", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "profileIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a feed of MediaSocialPost objects by profile", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaSocialPost3" } } } } } } } }, "\/api\/media\/social_post\/rss": { "get": { "summary": "Returns a list of media social post rss entries.", "operationId": "get_media_social_post_rss", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/social_post\/link_preview": { "get": { "tags": [ "Media \/ Social Posts" ], "summary": "Returns the link preview card as a post shows it, without saving anything - e.g. while a\npost is being written. A linked event wins over a linked article, which wins over a plain\nURL. url_subtitle is publicSubtitle, falling back to externalDescription (events) or\npublicDescription (articles); it is null for plain URLs. For plain URLs the page is fetched\nand url_image points to a signed image proxy. Linking events and articles requires\nsocial admin rights.", "operationId": "get_media_social_post_link_preview", "parameters": [ { "name": "url", "in": "query", "description": "Link of the post; https:\/\/ is added when no scheme is given", "required": false, "schema": { "type": "string" } }, { "name": "baseEvent", "in": "query", "description": "Id or identifier of a linked event (social admins only)", "required": false, "schema": { "type": "string" } }, { "name": "newsArticle", "in": "query", "description": "Id or identifier of a linked news article (social admins only)", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Link preview", "content": { "application\/json": { "schema": { "properties": { "type": { "type": "string", "enum": [ "base_event", "news_article", "url" ] }, "url": { "type": "string", "nullable": true }, "url_title": { "type": "string", "nullable": true }, "url_image": { "type": "string", "nullable": true }, "url_subtitle": { "type": "string", "nullable": true } }, "type": "object" } } } } } } }, "\/api\/media\/social_post\/{identifier}": { "get": { "tags": [ "Media \/ Social Posts" ], "summary": "Returns a single social post (three-tier visibility)", "operationId": "get_media_social_post_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaSocialPost", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPost4" } } } } } }, "put": { "tags": [ "Media \/ Social Posts" ], "summary": "Admin updates a social post", "operationId": "put_media_social_post_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPost2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Admin updates a social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPost" } } } } } }, "delete": { "tags": [ "Media \/ Social Posts" ], "summary": "Admin soft-deletes a social post", "operationId": "delete_media_social_post_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Media \/ Social Posts" ], "summary": "Admin updates a social post", "operationId": "patch_media_social_post_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPost2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Admin updates a social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPost" } } } } } } }, "\/api\/media\/social_post\/user": { "post": { "tags": [ "Media \/ Social Posts" ], "summary": "User creates a social post", "operationId": "post_media_social_post_user_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPost2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User creates a social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPost" } } } } } } }, "\/api\/media\/social_post\/trainer": { "post": { "tags": [ "Media \/ Social Posts" ], "summary": "Trainer creates a social post.", "description": "Requires the person to be a trainer in at least one of the assigned unified categories\n(via active PersonLogBookEntry) and those categories must have trainerCanPostSocial enabled.\nDoes NOT require the media_social_user_can_create_post setting.", "operationId": "post_media_social_post_trainer_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPost2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Trainer creates a social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPost" } } } } } } }, "\/api\/media\/social_post\/user\/{identifier}": { "put": { "tags": [ "Media \/ Social Posts" ], "summary": "User updates their own social post", "operationId": "put_media_social_post_user_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPost2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User updates their own social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPost" } } } } } }, "delete": { "tags": [ "Media \/ Social Posts" ], "summary": "User soft-deletes their own social post", "operationId": "delete_media_social_post_user_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Media \/ Social Posts" ], "summary": "User updates their own social post", "operationId": "patch_media_social_post_user_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPost2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User updates their own social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPost" } } } } } } }, "\/api\/media\/social_post\/trainer\/{identifier}": { "put": { "tags": [ "Media \/ Social Posts" ], "summary": "Trainer updates their own social post.", "description": "Does NOT require the media_social_user_can_edit_own_post setting.\nValidates ownership and that the person is a trainer in the post's categories.", "operationId": "put_media_social_post_trainer_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPost2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Trainer updates their own social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPost" } } } } } }, "delete": { "tags": [ "Media \/ Social Posts" ], "summary": "Trainer soft-deletes their own social post.", "description": "The counterpart to postTrainer \/ putTrainer: a trainer who may write and edit must\nalso be able to take a post back, without the media_social_user_can_delete_own_post\nsetting that governs ordinary members.", "operationId": "delete_media_social_post_trainer_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Media \/ Social Posts" ], "summary": "Trainer updates their own social post.", "description": "Does NOT require the media_social_user_can_edit_own_post setting.\nValidates ownership and that the person is a trainer in the post's categories.", "operationId": "patch_media_social_post_trainer_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPost2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Trainer updates their own social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPost" } } } } } } }, "\/api\/media\/social_report": { "get": { "tags": [ "Media \/ Social Reports" ], "summary": "Returns a list of content reports (admin only)", "operationId": "get_media_social_report_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE | Default value: false", "required": false, "schema": { "type": "boolean" } }, { "name": "socialPost", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comment", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "The reporting member. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaSocialReport objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaSocialReport" } } } } } } } }, "\/api\/media\/social_report\/user": { "post": { "tags": [ "Media \/ Social Reports" ], "summary": "A member reports a post or a comment.", "description": "Exactly one of socialPost \/ comment must be given. Content a moderator already\ndecided about by hand cannot be reported. Once enough different members have\nreported the same content, it goes back into moderation.", "operationId": "post_media_social_report_user_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialReport2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Member reports a post or a comment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialReport" } } } } } } }, "\/api\/media\/social_report\/{identifier}": { "get": { "tags": [ "Media \/ Social Reports" ], "summary": "Returns a single content report (admin only)", "operationId": "get_media_social_report_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaSocialReport object", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialReport" } } } } } }, "delete": { "tags": [ "Media \/ Social Reports" ], "summary": "Admin soft-deletes a report", "operationId": "delete_media_social_report_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a content report", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialReport" } } } } } } }, "\/api\/media\/social_post\/rss\/category\/{ucatId}": { "get": { "summary": "Returns the feed of a category.", "operationId": "get_media_social_post_rss_category", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "ucatId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/social_post_comment": { "get": { "tags": [ "Media \/ Social Post Comments" ], "summary": "Returns a list of social post comments (admin only)", "operationId": "get_media_social_post_comment_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "moderationStatus", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialPost", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaSocialPostComment objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaSocialPostComment" } } } } } } }, "post": { "tags": [ "Media \/ Social Post Comments" ], "summary": "Admin creates a comment", "operationId": "post_media_social_post_comment_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a comment to a social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostComment" } } } } } } }, "\/api\/media\/social_post_comment\/{identifier}": { "get": { "tags": [ "Media \/ Social Post Comments" ], "summary": "Returns a single social post comment", "operationId": "get_media_social_post_comment_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaSocialPostComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostComment" } } } } } }, "put": { "tags": [ "Media \/ Social Post Comments" ], "summary": "Admin updates a comment", "operationId": "put_media_social_post_comment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a social post comment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostComment" } } } } } }, "delete": { "tags": [ "Media \/ Social Post Comments" ], "summary": "Admin soft-deletes a comment", "operationId": "delete_media_social_post_comment_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Media \/ Social Post Comments" ], "summary": "Admin updates a comment", "operationId": "patch_media_social_post_comment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a social post comment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostComment" } } } } } } }, "\/api\/media\/social_post_comment\/user": { "post": { "tags": [ "Media \/ Social Post Comments" ], "summary": "User creates a comment", "operationId": "post_media_social_post_comment_user_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User adds a comment to a social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostComment" } } } } } } }, "\/api\/media\/social_post_comment\/user\/{identifier}": { "delete": { "tags": [ "Media \/ Social Post Comments" ], "summary": "User soft-deletes their own comment", "operationId": "delete_media_social_post_comment_user_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/social_post_reaction": { "get": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "Returns a list of reactions for posts (admin only)", "operationId": "get_media_social_post_reaction_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "emoji", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialPost", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaSocialPostReaction objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction" } } } } } } }, "post": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "Admin creates a reaction", "operationId": "post_media_social_post_reaction_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a reaction to a social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction" } } } } } } }, "\/api\/media\/social_post_reaction\/user": { "post": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "User creates a reaction", "operationId": "post_media_social_post_reaction_user_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User adds a reaction to a social post", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction" } } } } } } }, "\/api\/media\/social_post_reaction\/{identifier}": { "get": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "Returns a single post reaction (checks parent post accessibility)", "operationId": "get_media_social_post_reaction_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaSocialPostReaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction" } } } } } }, "put": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "Admin updates a reaction (emoji only)", "operationId": "put_media_social_post_reaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a post reaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction" } } } } } }, "delete": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "Admin deletes a reaction", "operationId": "delete_media_social_post_reaction_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "Admin updates a reaction (emoji only)", "operationId": "patch_media_social_post_reaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a post reaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction" } } } } } } }, "\/api\/media\/social_post_reaction\/user\/{identifier}": { "put": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "User updates their own reaction (emoji only)", "operationId": "put_media_social_post_reaction_user_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User updates their own post reaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction" } } } } } }, "delete": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "User removes their own reaction", "operationId": "delete_media_social_post_reaction_user_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "User updates their own reaction (emoji only)", "operationId": "patch_media_social_post_reaction_user_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User updates their own post reaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostReaction" } } } } } } }, "\/api\/media\/social_post_reaction\/user\/post\/{identifier}": { "delete": { "tags": [ "Media \/ Social Post Reactions" ], "summary": "A member takes back their own reaction on a post.", "description": "Addressed by the post, not by the reaction: the feed only ever tells a member how\nmany reactions a post carries, never the id of their own.", "operationId": "delete_media_social_post_reaction_user_delete_for_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/social_post_comment_reaction": { "get": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "Returns a list of reactions for comments (admin only)", "operationId": "get_media_social_post_comment_reaction_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "emoji", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "comment", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaSocialPostCommentReaction objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction" } } } } } } }, "post": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "Admin creates a comment reaction", "operationId": "post_media_social_post_comment_reaction_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a reaction to a comment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction" } } } } } } }, "\/api\/media\/social_post_comment_reaction\/user": { "post": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "User creates a comment reaction", "operationId": "post_media_social_post_comment_reaction_user_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User adds a reaction to a comment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction" } } } } } } }, "\/api\/media\/social_post_comment_reaction\/{identifier}": { "get": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "Returns a single comment reaction (checks parent post accessibility)", "operationId": "get_media_social_post_comment_reaction_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaSocialPostCommentReaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction" } } } } } }, "put": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "Admin updates a comment reaction (emoji only)", "operationId": "put_media_social_post_comment_reaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a comment reaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction" } } } } } }, "delete": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "Admin deletes a comment reaction", "operationId": "delete_media_social_post_comment_reaction_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "Admin updates a comment reaction (emoji only)", "operationId": "patch_media_social_post_comment_reaction_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a comment reaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction" } } } } } } }, "\/api\/media\/social_post_comment_reaction\/user\/{identifier}": { "put": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "User updates their own comment reaction (emoji only)", "operationId": "put_media_social_post_comment_reaction_user_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User updates their own comment reaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction" } } } } } }, "delete": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "User removes their own comment reaction", "operationId": "delete_media_social_post_comment_reaction_user_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "User updates their own comment reaction (emoji only)", "operationId": "patch_media_social_post_comment_reaction_user_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User updates their own comment reaction", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialPostCommentReaction" } } } } } } }, "\/api\/media\/social_post_comment_reaction\/user\/comment\/{identifier}": { "delete": { "tags": [ "Media \/ Social Post Comment Reactions" ], "summary": "A member takes back their own reaction on a comment.", "description": "Addressed by the comment, for the same reason as the post variant.", "operationId": "delete_media_social_post_comment_reaction_user_delete_for_comment", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/social_moderation_trigger": { "get": { "tags": [ "Media \/ Social Moderation Triggers" ], "summary": "Returns a list of moderation triggers", "operationId": "get_media_social_moderation_trigger_cget", "parameters": [ { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "post": { "tags": [ "Media \/ Social Moderation Triggers" ], "summary": "Creates a moderation trigger", "operationId": "post_media_social_moderation_trigger_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialModerationTrigger" } }, "type": "object" } } } }, "responses": { "200": { "description": "Create a moderation trigger", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialModerationTrigger2" } } } } } } }, "\/api\/media\/social_moderation_trigger\/{identifier}": { "get": { "tags": [ "Media \/ Social Moderation Triggers" ], "summary": "Returns a single moderation trigger", "operationId": "get_media_social_moderation_trigger_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "Media \/ Social Moderation Triggers" ], "summary": "Updates a moderation trigger", "operationId": "put_media_social_moderation_trigger_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialModerationTrigger" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a moderation trigger", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialModerationTrigger2" } } } } } }, "patch": { "tags": [ "Media \/ Social Moderation Triggers" ], "summary": "Updates a moderation trigger", "operationId": "patch_media_social_moderation_trigger_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaSocialModerationTrigger" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a moderation trigger", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaSocialModerationTrigger2" } } } } } } }, "\/api\/media\/feedback\/status": { "get": { "tags": [ "Media \/ Feedback Status" ], "summary": "Returns the feedback module status for the current session.", "operationId": "get_media_feedback_status", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/feedback_board": { "get": { "tags": [ "Media \/ Feedback Boards" ], "summary": "Returns a list of feedback boards (three-tier visibility).", "operationId": "get_media_feedback_board_cget", "parameters": [ { "name": "publicKey", "in": "query", "description": "Stable key for the public URL and widget embedding. Server-assigned, never accepted from API input \u2014 omitted from the oaInput groups on purpose. Changing it would break every page that already embeds this board. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "name", "in": "query", "description": "Internal name, shown in the admin UI only. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "visibilityType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "allowNewEntries", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "allowVoting", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "allowComments", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "allowGuestEntries", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "allowGuestVotes", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "allowGuestComments", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaFeedbackBoard objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackBoard" } } } } } } }, "post": { "tags": [ "Media \/ Feedback Boards" ], "summary": "Creates a feedback board.", "operationId": "post_media_feedback_board_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackBoard2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MediaFeedbackBoard", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackBoard" } } } } } } }, "\/api\/media\/feedback_board\/{identifier}": { "get": { "tags": [ "Media \/ Feedback Boards" ], "summary": "Returns a single feedback board.", "operationId": "get_media_feedback_board_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaFeedbackBoard", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackBoard" } } } } } }, "put": { "tags": [ "Media \/ Feedback Boards" ], "summary": "Updates a feedback board.", "operationId": "put_media_feedback_board_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackBoard2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaFeedbackBoard", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackBoard" } } } } } }, "delete": { "tags": [ "Media \/ Feedback Boards" ], "summary": "Soft-deletes a feedback board.", "operationId": "delete_media_feedback_board_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a MediaFeedbackBoard", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackBoard" } } } } } }, "patch": { "tags": [ "Media \/ Feedback Boards" ], "summary": "Updates a feedback board.", "operationId": "patch_media_feedback_board_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackBoard2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaFeedbackBoard", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackBoard" } } } } } } }, "\/api\/media\/feedback_entry": { "get": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Returns a list of feedback entries (three-tier visibility).", "operationId": "get_media_feedback_entry_cget", "parameters": [ { "name": "headline", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "board", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "feedbackType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Author when submitted by a logged-in person. Reuses the social profile so the pseudonymity settings a person already chose apply here too. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "voteCount", "in": "query", "description": "Denormalized so lists can sort by popularity without a join. Maintained by MediaFeedbackVoteHelper; MediaFeedbackRecountCommand repairs it. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "duplicateOf", "in": "query", "description": "Merge target. Set together with STATUS_DUPLICATE. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "moderationStatus", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "visibilityType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "commentCount", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "internalPriority", "in": "query", "description": "Scope-only. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "guestEmailConfirmed", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaFeedbackEntry objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } } }, "post": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Creates a feedback entry as an administrator.", "operationId": "post_media_feedback_entry_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MediaFeedbackEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } } }, "\/api\/media\/feedback_entry\/feed\/board\/{boardIdentifier}": { "get": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Returns the entries of one board, sorted and paginated.", "operationId": "get_media_feedback_entry_board_feed", "parameters": [ { "name": "headline", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "board", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "feedbackType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Author when submitted by a logged-in person. Reuses the social profile so the pseudonymity settings a person already chose apply here too. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "voteCount", "in": "query", "description": "Denormalized so lists can sort by popularity without a join. Maintained by MediaFeedbackVoteHelper; MediaFeedbackRecountCommand repairs it. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "duplicateOf", "in": "query", "description": "Merge target. Set together with STATUS_DUPLICATE. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "moderationStatus", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "visibilityType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "commentCount", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "internalPriority", "in": "query", "description": "Scope-only. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "guestEmailConfirmed", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "boardIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the entries of one board", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry3" } } } } } } } }, "\/api\/media\/feedback_entry\/feed\/own": { "get": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Returns the entries the current user submitted, including ones awaiting moderation.", "operationId": "get_media_feedback_entry_own_feed", "parameters": [ { "name": "headline", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "board", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "feedbackType", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Author when submitted by a logged-in person. Reuses the social profile so the pseudonymity settings a person already chose apply here too. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "voteCount", "in": "query", "description": "Denormalized so lists can sort by popularity without a join. Maintained by MediaFeedbackVoteHelper; MediaFeedbackRecountCommand repairs it. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "duplicateOf", "in": "query", "description": "Merge target. Set together with STATUS_DUPLICATE. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "moderationStatus", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "visibilityType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "commentCount", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "internalPriority", "in": "query", "description": "Scope-only. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "guestEmailConfirmed", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the caller's own entries", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry3" } } } } } } } }, "\/api\/media\/feedback_entry\/{identifier}": { "get": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Returns a single feedback entry.", "operationId": "get_media_feedback_entry_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaFeedbackEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } }, "put": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Updates a feedback entry as an administrator.", "operationId": "put_media_feedback_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaFeedbackEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } }, "delete": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Soft-deletes a feedback entry.", "operationId": "delete_media_feedback_entry_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a MediaFeedbackEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } }, "patch": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Updates a feedback entry as an administrator.", "operationId": "patch_media_feedback_entry_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaFeedbackEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } } }, "\/api\/media\/feedback_entry\/user": { "post": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Creates a feedback entry as a logged-in user.", "operationId": "post_media_feedback_entry_user_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User creates a feedback entry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry4" } } } } } } }, "\/api\/media\/feedback_entry\/{identifier}\/status": { "put": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Changes the status of an entry and records it in the public history.", "operationId": "put_media_feedback_entry_status_put", "parameters": [ { "name": "status", "in": "query", "description": "New status", "required": true, "schema": { "type": "string" } }, { "name": "statusNote", "in": "query", "description": "Publicly visible reason for the change", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Change the status of a MediaFeedbackEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } }, "patch": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Changes the status of an entry and records it in the public history.", "operationId": "patch_media_feedback_entry_status_put", "parameters": [ { "name": "status", "in": "query", "description": "New status", "required": true, "schema": { "type": "string" } }, { "name": "statusNote", "in": "query", "description": "Publicly visible reason for the change", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Change the status of a MediaFeedbackEntry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } } }, "\/api\/media\/feedback_entry\/{identifier}\/roadmap_item": { "put": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Turns an entry into a roadmap milestone and links the two.", "description": "Doing this by hand means creating a milestone, retyping the wish, finding the entry\nagain and linking it \u2014 four steps in which the linking is the one that gets skipped,\nleaving a roadmap nobody can trace back to what people asked for.\n\nThe entry moves to planned in the same call, because a milestone that exists while\nthe wish still reads \"open\" tells the board the opposite of what happened.", "operationId": "put_media_feedback_entry_roadmap_item_put", "parameters": [ { "name": "title", "in": "query", "description": "Milestone title, defaults to the entry headline", "required": false, "schema": { "type": "string" } }, { "name": "targetDate", "in": "query", "description": "Planned date (Y-m-d)", "required": false, "schema": { "type": "string" } }, { "name": "targetLabel", "in": "query", "description": "Free-text period, wins over targetDate in the UI", "required": false, "schema": { "type": "string" } }, { "name": "roadmapItemIdentifier", "in": "query", "description": "Link to this existing milestone instead of creating one", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Create a roadmap milestone from a feedback entry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem" } } } } } } }, "\/api\/media\/feedback_entry\/bulk_moderation": { "put": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Moderates several entries in one call.", "description": "Working a queue means making the same obvious decision many times over; one request\nper entry turns that into a page reload per entry. Unknown ids are reported back\nrather than failing the whole call \u2014 a stale list in the client must not lose the\ndecisions that were valid.", "operationId": "put_media_feedback_entry_bulk_moderation_put", "parameters": [ { "name": "identifiers", "in": "query", "description": "Comma separated entry identifiers", "required": true, "schema": { "type": "string" } }, { "name": "moderationStatus", "in": "query", "description": "Target moderation status", "required": true, "schema": { "type": "string" } }, { "name": "moderationReason", "in": "query", "description": "Reason shown to the author on rejection", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Moderate multiple feedback entries at once", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } } }, "\/api\/media\/feedback_entry\/{identifier}\/merge": { "put": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Merges this entry into another one as a duplicate.", "operationId": "put_media_feedback_entry_merge_put", "parameters": [ { "name": "targetIdentifier", "in": "query", "description": "Identifier of the entry to merge into", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Merge a MediaFeedbackEntry into another one", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } }, "patch": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Merges this entry into another one as a duplicate.", "operationId": "patch_media_feedback_entry_merge_put", "parameters": [ { "name": "targetIdentifier", "in": "query", "description": "Identifier of the entry to merge into", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Merge a MediaFeedbackEntry into another one", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } } } } } } }, "\/api\/media\/feedback_entry\/user\/{identifier}": { "put": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Updates the caller's own feedback entry.", "operationId": "put_media_feedback_entry_user_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User updates their own feedback entry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry4" } } } } } }, "delete": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Soft-deletes the caller's own feedback entry.", "operationId": "delete_media_feedback_entry_user_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "User deletes their own feedback entry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry4" } } } } } }, "patch": { "tags": [ "Media \/ Feedback Entries" ], "summary": "Updates the caller's own feedback entry.", "operationId": "patch_media_feedback_entry_user_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User updates their own feedback entry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry4" } } } } } } }, "\/api\/media\/feedback_vote": { "get": { "tags": [ "Media \/ Feedback Votes" ], "summary": "Returns a list of votes. Used for auditing suspicious voting patterns.", "operationId": "get_media_feedback_vote_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "entry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "voterEmailConfirmed", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "weight", "in": "query", "description": "Weight of this vote. Always 1 for now; the column exists so weighting can be added without a data migration. | Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "mergedFromEntryId", "in": "query", "description": "Id of the entry this vote originally belonged to before a duplicate merge. Plain int, no foreign key \u2014 the source entry may be hard-deleted later and that must not cascade into the merged vote. | Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaFeedbackVote objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackVote" } } } } } } } }, "\/api\/media\/feedback_vote\/user": { "post": { "tags": [ "Media \/ Feedback Votes" ], "summary": "Casts the caller's vote on an entry.", "description": "Idempotent: voting twice reports already_voted rather than failing, so a double tap in\nthe UI does not surface as an error.", "operationId": "post_media_feedback_vote_user_post", "parameters": [ { "name": "entryIdentifier", "in": "query", "description": "Identifier of the entry to vote for", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "User votes for a feedback entry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackVote" } } } } } } }, "\/api\/media\/feedback_vote\/user\/{entryIdentifier}": { "delete": { "tags": [ "Media \/ Feedback Votes" ], "summary": "Withdraws the caller's vote on an entry.", "operationId": "delete_media_feedback_vote_user_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "entryIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "User withdraws their vote", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackVote" } } } } } } }, "\/api\/media\/feedback_vote\/{identifier}": { "delete": { "tags": [ "Media \/ Feedback Votes" ], "summary": "Removes a single vote as an administrator, for cases of proven abuse.", "operationId": "delete_media_feedback_vote_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a MediaFeedbackVote", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackVote" } } } } } } }, "\/api\/media\/feedback_subscription": { "get": { "tags": [ "Media \/ Feedback Subscriptions" ], "summary": "Returns a list of subscriptions.", "operationId": "get_media_feedback_subscription_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "entry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaFeedbackSubscription objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackSubscription" } } } } } } } }, "\/api\/media\/feedback_subscription\/user": { "get": { "tags": [ "Media \/ Feedback Subscriptions" ], "summary": "Returns the entries the caller follows.", "description": "Its own endpoint rather than a filter on cget, because cget needs the feedback scope\nand a member following their own wishes has no scope at all.", "operationId": "get_media_feedback_subscription_user_cget", "parameters": [ { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "entry", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the caller's subscriptions", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackSubscription" } } } } } } }, "post": { "tags": [ "Media \/ Feedback Subscriptions" ], "summary": "Subscribes the caller to an entry.", "description": "Idempotent: subscribing twice reports already_subscribed rather than failing.", "operationId": "post_media_feedback_subscription_user_post", "parameters": [ { "name": "entryIdentifier", "in": "query", "description": "Identifier of the entry to follow", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "User subscribes to a feedback entry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackSubscription" } } } } } } }, "\/api\/media\/feedback_subscription\/user\/{entryIdentifier}": { "delete": { "tags": [ "Media \/ Feedback Subscriptions" ], "summary": "Unsubscribes the caller from an entry.", "operationId": "delete_media_feedback_subscription_user_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "entryIdentifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "User unsubscribes from a feedback entry", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackSubscription" } } } } } } }, "\/api\/media\/feedback_subscription\/{identifier}": { "delete": { "tags": [ "Media \/ Feedback Subscriptions" ], "summary": "Removes a subscription as an administrator.", "operationId": "delete_media_feedback_subscription_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a MediaFeedbackSubscription", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackSubscription" } } } } } } }, "\/api\/media\/feedback_comment": { "get": { "tags": [ "Media \/ Feedback Comments" ], "summary": "Returns a list of feedback comments (three-tier visibility).", "operationId": "get_media_feedback_comment_cget", "parameters": [ { "name": "entry", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "socialProfile", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "isOfficial", "in": "query", "description": "Marks a reply written on behalf of the operator, so the UI can set it apart from community comments. | Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "created", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "moderationStatus", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns a list of MediaFeedbackComment objects", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackComment" } } } } } } }, "post": { "tags": [ "Media \/ Feedback Comments" ], "summary": "Creates a comment as an administrator.", "operationId": "post_media_feedback_comment_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MediaFeedbackComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackComment" } } } } } } }, "\/api\/media\/feedback_comment\/{identifier}": { "get": { "tags": [ "Media \/ Feedback Comments" ], "summary": "Returns a single feedback comment.", "operationId": "get_media_feedback_comment_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaFeedbackComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackComment" } } } } } }, "put": { "tags": [ "Media \/ Feedback Comments" ], "summary": "Updates a comment as an administrator.", "operationId": "put_media_feedback_comment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaFeedbackComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackComment" } } } } } }, "delete": { "tags": [ "Media \/ Feedback Comments" ], "summary": "Soft-deletes a comment.", "operationId": "delete_media_feedback_comment_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a MediaFeedbackComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackComment" } } } } } }, "patch": { "tags": [ "Media \/ Feedback Comments" ], "summary": "Updates a comment as an administrator.", "operationId": "patch_media_feedback_comment_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaFeedbackComment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackComment" } } } } } } }, "\/api\/media\/feedback_comment\/user": { "post": { "tags": [ "Media \/ Feedback Comments" ], "summary": "Creates a comment as a logged-in user.", "operationId": "post_media_feedback_comment_user_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackComment2" } }, "type": "object" } } } }, "responses": { "200": { "description": "User creates a feedback comment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackComment3" } } } } } } }, "\/api\/media\/feedback_comment\/bulk_moderation": { "put": { "tags": [ "Media \/ Feedback Comments" ], "summary": "Moderates several comments in one call.", "description": "Comment moderation is on by default, so this queue is the one that fills up fastest\n\u2014 and approving thirty harmless replies one request at a time is the work nobody\ndoes, which is how a moderated board ends up looking dead.\n\nApproving or hiding also refreshes the comment counters of the entries involved,\nbecause the count only includes visible comments.", "operationId": "put_media_feedback_comment_bulk_moderation_put", "parameters": [ { "name": "identifiers", "in": "query", "description": "Comma separated comment identifiers", "required": true, "schema": { "type": "string" } }, { "name": "moderationStatus", "in": "query", "description": "Target moderation status", "required": true, "schema": { "type": "string" } }, { "name": "moderationReason", "in": "query", "description": "Reason kept with the comment", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Moderate multiple comments at once", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackComment" } } } } } } }, "\/api\/media\/feedback_comment\/user\/{identifier}": { "delete": { "tags": [ "Media \/ Feedback Comments" ], "summary": "Soft-deletes the caller's own comment.", "operationId": "delete_media_feedback_comment_user_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "User deletes their own comment", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackComment3" } } } } } } }, "\/api\/media\/feedback_roadmap_item": { "get": { "tags": [ "Media \/ Feedback Roadmap" ], "summary": "Returns the roadmap timeline, ordered by status group and target date.", "operationId": "get_media_feedback_roadmap_item_cget", "parameters": [ { "name": "status", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "targetDate", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "releasedAt", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "description": "Requires access right: PUBLIC, LOGGED_IN, SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "integer" } }, { "name": "deleted", "in": "query", "description": "This property is used to mark an entity as deleted \/ archived | Requires access right: SCOPE", "required": false, "schema": { "type": "boolean" } }, { "name": "title", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "visibilityType", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "releaseVersion", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "created", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "name": "updated", "in": "query", "description": "Requires access right: SCOPE", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/searchString" }, { "$ref": "#\/components\/parameters\/orderFieldName" }, { "$ref": "#\/components\/parameters\/orderFieldSort" }, { "$ref": "#\/components\/parameters\/page" }, { "$ref": "#\/components\/parameters\/pageSize" }, { "$ref": "#\/components\/parameters\/withMaxPageNumber" }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Returns the roadmap timeline", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem" } } } } } } }, "post": { "tags": [ "Media \/ Feedback Roadmap" ], "summary": "Creates a roadmap milestone.", "operationId": "post_media_feedback_roadmap_item_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Add a new MediaFeedbackRoadmapItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem" } } } } } } }, "\/api\/media\/feedback_roadmap_item\/{identifier}": { "get": { "tags": [ "Media \/ Feedback Roadmap" ], "summary": "Returns a single roadmap milestone.", "operationId": "get_media_feedback_roadmap_item_get", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a single MediaFeedbackRoadmapItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem" } } } } } }, "put": { "tags": [ "Media \/ Feedback Roadmap" ], "summary": "Updates a roadmap milestone.", "description": "Setting the status to done stamps releasedAt if it is still empty, so \"shipped\" and\n\"when\" cannot drift apart through a forgotten field.", "operationId": "put_media_feedback_roadmap_item_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaFeedbackRoadmapItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem" } } } } } }, "delete": { "tags": [ "Media \/ Feedback Roadmap" ], "summary": "Soft-deletes a roadmap milestone.", "operationId": "delete_media_feedback_roadmap_item_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete a MediaFeedbackRoadmapItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem" } } } } } }, "patch": { "tags": [ "Media \/ Feedback Roadmap" ], "summary": "Updates a roadmap milestone.", "description": "Setting the status to done stamps releasedAt if it is still empty, so \"shipped\" and\n\"when\" cannot drift apart through a forgotten field.", "operationId": "patch_media_feedback_roadmap_item_put", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem2" } }, "type": "object" } } } }, "responses": { "200": { "description": "Update a MediaFeedbackRoadmapItem", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem" } } } } } } }, "\/api\/media\/feedback_roadmap_item\/{identifier}\/complete_entries": { "put": { "tags": [ "Media \/ Feedback Roadmap" ], "summary": "Marks every entry linked to this milestone as complete.", "description": "Deliberately a separate, explicit call rather than a side effect of setting the\nmilestone to done: it notifies every author and writes public history, and that is\nnot something a status edit should trigger by surprise.", "operationId": "put_media_feedback_roadmap_item_complete_entries_put", "parameters": [ { "name": "statusNote", "in": "query", "description": "Publicly visible note applied to every linked entry", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Complete all entries linked to a roadmap item", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem" } } } } } }, "patch": { "tags": [ "Media \/ Feedback Roadmap" ], "summary": "Marks every entry linked to this milestone as complete.", "description": "Deliberately a separate, explicit call rather than a side effect of setting the\nmilestone to done: it notifies every author and writes public history, and that is\nnot something a status edit should trigger by surprise.", "operationId": "patch_media_feedback_roadmap_item_complete_entries_put", "parameters": [ { "name": "statusNote", "in": "query", "description": "Publicly visible note applied to every linked entry", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Complete all entries linked to a roadmap item", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem" } } } } } } }, "\/api\/media\/feedback_public\/roadmap": { "get": { "tags": [ "Media \/ Feedback Public" ], "summary": "The public roadmap timeline.", "operationId": "get_media_feedback_public_roadmap", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/feedback_public\/confirm\/{confirmToken}": { "get": { "tags": [ "Media \/ Feedback Public" ], "summary": "Confirms a guest submission or vote from the double opt-in link.", "description": "The token is cleared on use, so a forwarded mail cannot be replayed.", "operationId": "get_media_feedback_public_confirm", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "confirmToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/feedback_public\/board\/{publicKey}\/entry\/{identifier}": { "get": { "tags": [ "Media \/ Feedback Public" ], "summary": "A single public entry with its comments and status history.", "operationId": "get_media_feedback_public_board_entry_get", "parameters": [ { "name": "voterToken", "in": "query", "description": "Caller's own voter token", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "publicKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/feedback_public\/board\/{publicKey}\/entry": { "post": { "tags": [ "Media \/ Feedback Public" ], "summary": "Submits an entry without a session.", "description": "The response carries the guest token exactly once \u2014 it is the only way the guest can\ncome back to their own entry, and it is never serialized again afterwards.", "operationId": "post_media_feedback_public_board_entry_post", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "publicKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "data": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry2" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/media\/feedback_public\/board\/{publicKey}\/vote": { "post": { "tags": [ "Media \/ Feedback Public" ], "summary": "Casts a guest vote.", "operationId": "post_media_feedback_public_board_vote_post", "parameters": [ { "name": "entryIdentifier", "in": "query", "description": "Entry to vote for", "required": true, "schema": { "type": "string" } }, { "name": "voterToken", "in": "query", "description": "Caller's own voter token", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "publicKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "Media \/ Feedback Public" ], "summary": "Withdraws a guest vote.", "operationId": "delete_media_feedback_public_board_vote_delete", "parameters": [ { "name": "entryIdentifier", "in": "query", "description": "Entry to withdraw the vote from", "required": true, "schema": { "type": "string" } }, { "name": "voterToken", "in": "query", "description": "Caller's own voter token", "required": true, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "publicKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/media\/feedback_public\/board\/{publicKey}": { "get": { "tags": [ "Media \/ Feedback Public" ], "summary": "Board, capabilities, limits and the first page of entries \u2014 everything the widget\nneeds to draw itself, in one request. Split across several calls it would flicker\nwhile it works out what it is allowed to show.", "operationId": "get_media_feedback_public_board_get", "parameters": [ { "name": "sort", "in": "query", "description": "top, new or status", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by entry status", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Page size, max 100", "required": false, "schema": { "type": "integer" } }, { "name": "voterToken", "in": "query", "description": "Caller's own voter token, to mark entries they already voted for", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "publicKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/homeassistant\/bookables": { "get": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Returns a list of bookable resources for Home Assistant.", "description": "Each entry contains id and name.", "operationId": "get_homeassistant_bookables", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/homeassistant\/calendar\/{identifier}": { "get": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Returns a calendar feed (iCal) for a single bookable resource.", "operationId": "get_homeassistant_calendar", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/homeassistant\/booking\/{identifier}": { "get": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Returns the iCal for a single booking entry plus its bookable ID.", "description": "Used by the webhook handler to patch a single event into the calendar\nwithout fetching the full calendar feed.", "operationId": "get_homeassistant_booking", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/homeassistant\/webhook": { "post": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Register a webhook so the ERP notifies Home Assistant when bookings change.", "description": "Expects JSON body: {\"webhook_url\": \"https:\/\/ha-instance\/api\/webhook\/iw_erp_homeassistant\"}\n\nCreates a RegisteredWebhook entry for BaseBooking create\/update\/delete events.\n\nOptional \"events\": [\"access\", \"check_in\"] - with integration_ha_access_events_enabled the ERP\nalso reports smart lock accesses and check-ins to the same URL (body without the entity, only\nwebhook_data). Every registration states the full list: events left out are removed. The answer\nthen carries \"events\", the events that are active.\n\nOptional \"webhook_token\": a secret of 16-190 printable characters, sent back with every\nwebhook of the URL as X-IW-Webhook-Token so Home Assistant can reject forged calls.", "operationId": "post_homeassistant_webhook_register", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Unregister a Home Assistant webhook.", "description": "Expects JSON body: {\"webhook_url\": \"https:\/\/ha-instance\/api\/webhook\/iw_erp_homeassistant\"}", "operationId": "delete_homeassistant_webhook_unregister", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/homeassistant\/smart_locks": { "get": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "ERP smart locks the API key's user may use, for the lock entities of the Home Assistant\nintegration (\"Import ERP smart locks\", opt-in in Home Assistant). Locks that the calling\nHome Assistant instance offers itself are left out (excludeHaInstanceId).", "operationId": "get_homeassistant_smart_locks", "parameters": [ { "name": "excludeHaInstanceId", "in": "query", "description": "Home Assistant instance id whose own locks are skipped", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Smart locks accessible for the API key's user", "content": { "application\/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "type": "object" } } } } } } } }, "\/api\/homeassistant\/smart_locks\/{identifier}\/status": { "get": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Current state of an ERP smart lock, mapped to the Home Assistant lock states\n(locked, unlocked, open, locking, unlocking, opening, jammed, unknown). Asks the lock provider;\nunlike \/api\/event\/smart_lock\/{id}\/status it writes no smart lock log entry, because Home\nAssistant polls it.", "operationId": "get_homeassistant_smart_lock_status", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "State of the smart lock", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "integer" }, "state": { "type": "string" } }, "type": "object" } } } } } } }, "\/api\/homeassistant\/smart_locks\/{identifier}\/lock": { "post": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Locks an ERP smart lock from Home Assistant. Same access rules and smart lock log as\n\/api\/event\/smart_lock\/{id}\/lock.", "operationId": "post_homeassistant_smart_lock_lock", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/homeassistant\/smart_locks\/{identifier}\/unlock": { "post": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Opens an ERP smart lock from Home Assistant. Same access rules and smart lock log as\n\/api\/event\/smart_lock\/{id}\/unlock.", "operationId": "post_homeassistant_smart_lock_unlock", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/homeassistant\/ha_locks": { "post": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Home Assistant offers its locks to the ERP (\"Offer Home Assistant locks\", opt-in in Home Assistant).", "description": "Creates or updates a smart lock connection (provider \"homeassistant\") for the instance. The locks\nonly become ERP smart locks when an administrator syncs the devices of that connection.\n\nExpects JSON body:\n {\n \"instance_id\": \"\",\n \"name\": \"Home Assistant\",\n \"webhook_url\": \"https:\/\/ha.example.com\/api\/webhook\/iw_erp_homeassistant\",\n \"secret\": \"\",\n \"locks\": [{\"entity_id\": \"lock.front_door\", \"name\": \"Front door\", \"state\": \"locked\", \"supports_open\": true}]\n }\n\nAn instance that is already connected must send the secret it registered with. After the\nconnection was removed (DELETE), the instance can register again with a new secret.", "operationId": "post_homeassistant_ha_locks_sync", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Home Assistant stops offering its locks (opt-in switched off or integration removed).", "description": "Expects JSON body: {\"instance_id\": \"...\", \"secret\": \"...\"}. Marks the connection as deleted; its\nsmart locks stay but can no longer be used until the instance registers again.", "operationId": "delete_homeassistant_ha_locks_delete", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/homeassistant\/displays": { "get": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Room displays Home Assistant delivers to: the OpenDisplay receivers.", "description": "OpenDisplay panels are pushed to over Bluetooth by a sender next to them,\nand Home Assistant with the OpenDisplay integration is exactly that. Home\nAssistant authenticates with its API token here, so no device secret has to\nbe copied into its configuration.", "operationId": "get_homeassistant_displays", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "OpenDisplay receivers", "content": { "application\/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "device_id": { "type": "string" }, "target": { "type": "string", "nullable": true }, "refresh_seconds": { "type": "integer" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "type": "object" } } } } } } } }, "\/api\/homeassistant\/displays\/{identifier}\/frame.png": { "get": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "The current frame of one OpenDisplay receiver, for Home Assistant to upload.", "description": "The same response the device path \/display\/opendisplay\/{deviceId} gives -\nPNG, ETag \/ If-None-Match, X-Refresh-After - authenticated by the API token\ninstead of the device secret. Fetching is not telemetry: Home Assistant\nbeing up says nothing about the panel, so this does not touch lastSeenAt.", "operationId": "get_homeassistant_display_frame", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Frame as PNG in the panel resolution", "content": { "image\/png": [] } }, "304": { "description": "Frame unchanged, do not upload" } } } }, "\/api\/homeassistant\/displays\/{identifier}\/telemetry": { "post": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "What Home Assistant knows about the panel: battery, signal, firmware and\nwhen it was last heard of.", "description": "last_seen is the panel's own last contact as Home Assistant saw it, not the\ntime of this request - the offline report has to catch a dead panel behind\na living Home Assistant. Without it the upload that just worked counts.", "operationId": "post_homeassistant_display_telemetry", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "battery_mv": { "type": "number", "nullable": true }, "battery_voltage": { "type": "number", "nullable": true }, "rssi": { "type": "integer", "nullable": true }, "firmware": { "type": "string", "nullable": true }, "last_seen": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/homeassistant\/occupancy": { "get": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Occupancy of the bookables for the occupancy sensors (integration_occupancy_api_enabled): booking\nnow, lead time before the next one, lag time after the last one, next booking, opening hours.", "description": "Also served at \/api\/event\/bookable_occupancy for Node-RED and n8n.", "operationId": "get_homeassistant_occupancy", "parameters": [ { "name": "bookable", "in": "query", "description": "Comma separated bookable ids, default all", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Occupancy per bookable", "content": { "application\/json": { "schema": { "properties": { "generated_at": { "type": "string", "format": "date-time" }, "bookables": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "location_id": { "type": "integer", "nullable": true }, "location_name": { "type": "string", "nullable": true }, "occupied": { "type": "boolean" }, "pre_start_active": { "type": "boolean" }, "post_end_active": { "type": "boolean" }, "pre_start_minutes": { "type": "integer" }, "post_end_minutes": { "type": "integer" }, "current_booking": { "type": "object", "nullable": true }, "next_booking": { "type": "object", "nullable": true }, "opening_hours": { "type": "object", "nullable": true } }, "type": "object" } } }, "type": "object" } } } } } } }, "\/api\/homeassistant\/usage_counters": { "get": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Usage counters of the bookables, for meters Home Assistant reports (integration_usage_counter_api_enabled).", "operationId": "get_homeassistant_usage_counters", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Usage counters", "content": { "application\/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string", "nullable": true }, "bookable_id": { "type": "integer", "nullable": true }, "bookable_name": { "type": "string", "nullable": true }, "value": { "type": "number" }, "unit": { "type": "string", "nullable": true }, "use_real_usage_data": { "type": "boolean" }, "updated": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } } } } } } } }, "\/api\/homeassistant\/usage_counters\/{identifier}": { "post": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "A meter reading from Home Assistant: sets the value of a usage counter. Counters fed by the\nreal usage data of the bookings are refused, Home Assistant would overwrite their sums.", "description": "Expects JSON body {\"value\": 1240.2}.", "operationId": "post_homeassistant_usage_counter_report", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application\/json": { "schema": { "properties": { "value": { "type": "number" } }, "type": "object" } } } }, "responses": { "default": { "description": "" } } } }, "\/api\/homeassistant\/check_access": { "post": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "May a credential a reader at Home Assistant read (RFID card, member card QR, access code of\nthe app) open a lock (integration_ha_access_check_enabled)? Same rules and smart lock log as\nthe access check of Node-RED, with the source \"homeassistant\".", "description": "Expects JSON body:\n{\n \"credential\": \"04A1B2C3D4\", \"credential_type\": \"auto\", \/\/ auto, access_code, member_card or card\n \"smart_lock_id\": 12, \/\/ any ERP smart lock\n \"instance_id\": \"...\", \"lock_id\": \"lock.front_door\", \/\/ or a lock this Home Assistant offers\n \"open\": false \/\/ ERP opens a lock of another provider itself\n}", "operationId": "post_homeassistant_check_access", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Access decision", "content": { "application\/json": { "schema": { "properties": { "granted": { "type": "boolean" }, "reason": { "type": "string" }, "credential_type": { "type": "string" }, "smart_lock": { "type": "object" }, "person": { "type": "object", "nullable": true }, "opened": { "type": "boolean", "nullable": true } }, "type": "object" } } } } } } }, "\/api\/homeassistant\/ticket": { "post": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "A fault report of Home Assistant as a ticket (integration_ha_ticket_enabled), e.g. a water alarm.", "description": "Expects JSON body {\"title\": \"...\", \"description\": \"...\", \"bookable_id\": 7, \"priority\": \"low|normal|high|urgent\",\n\"dedupe_key\": \"water_leak_hall_1\"}; while a ticket with the dedupe key is open no second one is created.", "operationId": "post_homeassistant_ticket", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Ticket", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "integer" }, "status": { "description": "created or already_open", "type": "string" } }, "type": "object" } } } } } } }, "\/api\/event\/bookable_occupancy": { "get": { "tags": [ "DataWarehouse \/ HomeAssistant" ], "summary": "Occupancy of the bookables for the occupancy sensors (integration_occupancy_api_enabled): booking\nnow, lead time before the next one, lag time after the last one, next booking, opening hours.", "description": "Also served at \/api\/event\/bookable_occupancy for Node-RED and n8n.", "operationId": "get_event_bookable_occupancy", "parameters": [ { "name": "bookable", "in": "query", "description": "Comma separated bookable ids, default all", "required": false, "schema": { "type": "string" } }, { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Occupancy per bookable", "content": { "application\/json": { "schema": { "properties": { "generated_at": { "type": "string", "format": "date-time" }, "bookables": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "location_id": { "type": "integer", "nullable": true }, "location_name": { "type": "string", "nullable": true }, "occupied": { "type": "boolean" }, "pre_start_active": { "type": "boolean" }, "post_end_active": { "type": "boolean" }, "pre_start_minutes": { "type": "integer" }, "post_end_minutes": { "type": "integer" }, "current_booking": { "type": "object", "nullable": true }, "next_booking": { "type": "object", "nullable": true }, "opening_hours": { "type": "object", "nullable": true } }, "type": "object" } } }, "type": "object" } } } } } } }, "\/api\/nodered\/smart_lock\/register": { "post": { "tags": [ "DataWarehouse \/ Node-RED" ], "summary": "Node-RED offers its locks. Creates or updates a smart lock connection (provider \"nodered\"); the\nlocks become smart locks when an administrator syncs the devices of that connection.", "description": "Expects JSON body:\n{\n \"instance_id\": \"\",\n \"secret\": \"\",\n \"name\": \"Node-RED Vereinsheim\",\n \"delivery\": \"mqtt\", \/\/ mqtt (default, ERP publishes on its broker) or push\n \"webhook_url\": \"https:\/\/\u2026\", \/\/ push only: receives the signed commands\n \"locks\": [{\"id\": \"front_door\", \"name\": \"Haupteingang\", \"state\": \"locked\", \"unlock_method\": \"remote\"}]\n}", "operationId": "post_nodered_smart_lock_register", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Registration result", "content": { "application\/json": { "schema": { "properties": { "status": { "description": "created, updated or restored", "type": "string" }, "connection_id": { "type": "integer" }, "locks": { "type": "integer" }, "smart_locks": { "description": "smart locks the administrator already synced", "type": "integer" }, "mqtt": { "description": "delivery mqtt: broker access of the bridge", "properties": { "url": { "type": "string" }, "username": { "type": "string" }, "password": { "description": "MQTT JWT, valid 30 days", "type": "string" }, "client_id": { "type": "string" }, "topic": { "type": "string" }, "valid_until": { "type": "string" } }, "type": "object", "nullable": true } }, "type": "object" } } } } } }, "delete": { "tags": [ "DataWarehouse \/ Node-RED" ], "summary": "Node-RED stops offering its locks. Expects JSON body {\"instance_id\": \"...\", \"secret\": \"...\"}.", "operationId": "delete_nodered_smart_lock_unregister", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/nodered\/smart_lock\/commands\/{identifier}\/result": { "post": { "tags": [ "DataWarehouse \/ Node-RED" ], "summary": "Result of a command Node-RED got over MQTT. Expects JSON body\n{\"instance_id\": \"...\", \"secret\": \"...\", \"success\": true, \"state\": \"unlocked\", \"message\": \"...\"}.", "operationId": "post_nodered_smart_lock_command_result", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" }, { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "default": { "description": "" } } } }, "\/api\/nodered\/smart_lock\/check_access": { "post": { "tags": [ "DataWarehouse \/ Node-RED" ], "summary": "May a credential a reader at Node-RED read (app QR code of the lock, member card QR, RFID card\nnumber) open the lock? Writes the smart lock log.", "description": "Expects JSON body:\n{\n \"instance_id\": \"...\", \"lock_id\": \"front_door\", \/\/ a lock of this Node-RED instance\n \"smart_lock_id\": 12, \/\/ or any ERP smart lock\n \"credential\": \"04A1B2C3D4\",\n \"credential_type\": \"auto\", \/\/ auto, access_code, member_card or card\n \"open\": false \/\/ ERP opens a lock of another provider itself\n}", "operationId": "post_nodered_smart_lock_check_access", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Access decision", "content": { "application\/json": { "schema": { "properties": { "granted": { "type": "boolean" }, "reason": { "description": "granted, unknown_credential, no_access, invalid_code or code_expired", "type": "string" }, "credential_type": { "type": "string" }, "smart_lock": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "person": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object", "nullable": true }, "opened": { "type": "boolean", "nullable": true } }, "type": "object" } } } } } } }, "\/api\/nodered\/webhook": { "post": { "tags": [ "DataWarehouse \/ N8n Webhooks" ], "summary": "Register (or update) an n8n webhook for ERP entity changes.", "description": "Expects JSON body:\n {\n \"webhook_url\": \"https:\/\/n8n.example.com\/webhook\/inwendo-erp\",\n \"reference_class_name\": \"CRMCompany\", \/\/ optional, null = all classes\n \"database_action\": \"update\", \/\/ optional, null = all actions\n \"webhook_token\": \"...\", \/\/ optional shared secret\n \"delivery\": \"mqtt\", \/\/ Node-RED only: over the ERP's MQTT broker\n \"instance_id\": \"...\" \/\/ mqtt only, instead of webhook_url\n }\n\ndatabase_action may also be a timed booking event (booking_pre_start, booking_start,\nbooking_end, booking_post_end or booking_timed for all four, integration_booking_timed_events_enabled);\nsuch a webhook gets only those events.\n\nWith delivery mqtt (integration_mqtt_trigger_enabled) the ERP publishes the webhook on its broker\nand the answer carries \"mqtt\" (url, username, password, client_id, topic, valid_until) like the\nlock bridge's registration; the node registers again before valid_until.\n\nIf a non-deleted webhook with the same notificationUrl and\nnotificationClientId = 'n8n' already exists, it is updated in place\n(or returned unchanged if every field already matches).", "operationId": "post_nodered_webhook_register", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "DataWarehouse \/ N8n Webhooks" ], "summary": "Unregister all n8n webhooks for a given webhook URL.", "description": "Expects JSON body:\n {\n \"webhook_url\": \"https:\/\/n8n.example.com\/webhook\/inwendo-erp\"\n }\nor, for a Node-RED trigger with MQTT delivery, {\"instance_id\": \"...\"}.\n\nSoft-deletes all non-deleted rows whose notificationUrl matches and\nwhose notificationClientId is 'n8n'. Other clients' webhooks are\nuntouched.", "operationId": "delete_nodered_webhook_unregister", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/n8n\/webhook": { "post": { "tags": [ "DataWarehouse \/ N8n Webhooks" ], "summary": "Register (or update) an n8n webhook for ERP entity changes.", "description": "Expects JSON body:\n {\n \"webhook_url\": \"https:\/\/n8n.example.com\/webhook\/inwendo-erp\",\n \"reference_class_name\": \"CRMCompany\", \/\/ optional, null = all classes\n \"database_action\": \"update\", \/\/ optional, null = all actions\n \"webhook_token\": \"...\", \/\/ optional shared secret\n \"delivery\": \"mqtt\", \/\/ Node-RED only: over the ERP's MQTT broker\n \"instance_id\": \"...\" \/\/ mqtt only, instead of webhook_url\n }\n\ndatabase_action may also be a timed booking event (booking_pre_start, booking_start,\nbooking_end, booking_post_end or booking_timed for all four, integration_booking_timed_events_enabled);\nsuch a webhook gets only those events.\n\nWith delivery mqtt (integration_mqtt_trigger_enabled) the ERP publishes the webhook on its broker\nand the answer carries \"mqtt\" (url, username, password, client_id, topic, valid_until) like the\nlock bridge's registration; the node registers again before valid_until.\n\nIf a non-deleted webhook with the same notificationUrl and\nnotificationClientId = 'n8n' already exists, it is updated in place\n(or returned unchanged if every field already matches).", "operationId": "post_n8n_webhook_register", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "DataWarehouse \/ N8n Webhooks" ], "summary": "Unregister all n8n webhooks for a given webhook URL.", "description": "Expects JSON body:\n {\n \"webhook_url\": \"https:\/\/n8n.example.com\/webhook\/inwendo-erp\"\n }\nor, for a Node-RED trigger with MQTT delivery, {\"instance_id\": \"...\"}.\n\nSoft-deletes all non-deleted rows whose notificationUrl matches and\nwhose notificationClientId is 'n8n'. Other clients' webhooks are\nuntouched.", "operationId": "delete_n8n_webhook_unregister", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/n8n\/smart_lock\/register": { "post": { "tags": [ "DataWarehouse \/ n8n" ], "summary": "An n8n lock trigger offers its locks. Expects JSON body like \/api\/nodered\/smart_lock\/register with\n\"delivery\": \"push\" and \"webhook_url\" (the trigger's production webhook URL).", "operationId": "post_n8n_smart_lock_register", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "DataWarehouse \/ n8n" ], "summary": "The lock trigger was deactivated. Expects JSON body {\"instance_id\": \"...\", \"secret\": \"...\"}.", "operationId": "delete_n8n_smart_lock_unregister", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/n8n\/smart_lock\/check_access": { "post": { "tags": [ "DataWarehouse \/ n8n" ], "summary": "Access check of a reader whose numbers an n8n workflow passes on; same body and answer as\n\/api\/nodered\/smart_lock\/check_access (instance_id + lock_id of a lock trigger, or smart_lock_id).", "operationId": "post_n8n_smart_lock_check_access", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "default": { "description": "" } } } }, "\/api\/shop\/shopify\/order": { "post": { "tags": [ "Billing \/ Shopify" ], "summary": "Creates an order.", "operationId": "post_shopify_order_webhook", "parameters": [ { "$ref": "#\/components\/parameters\/iw-build-id" }, { "$ref": "#\/components\/parameters\/iw-package-id" } ], "responses": { "200": { "description": "Shopify event durably accepted" }, "401": { "description": "Invalid shop or HMAC" }, "400": { "description": "Invalid payload" } } } } }, "components": { "schemas": { "AccessRightStorage": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User42" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage10": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User53" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage11": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage12": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User55" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage13": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User56" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage14": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User57" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage2": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage3": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User46" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage4": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User47" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage5": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User48" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage6": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User49" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage7": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User50" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage8": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessRightStorage9": { "properties": { "id": { "title": "Primary key of the access right entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who gets the access right.", "description": "Only set for user-specific rights.", "oneOf": [ { "$ref": "#\/components\/schemas\/User52" } ] }, "access_tag": { "title": "Access tag the right applies to.", "description": "Only set for rights on a tag.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "create_main": { "title": "Create permission for main records of the access tag.", "type": "boolean" }, "edit_main": { "title": "Edit permission for main records of the access tag.", "type": "boolean" }, "read_main": { "title": "Read permission for main records of the access tag.", "type": "boolean" }, "create_child": { "title": "Create permission for child records (for example items inside a main record).", "type": "boolean" }, "edit_child": { "title": "Edit permission for child records (for example items inside a main record).", "type": "boolean" }, "read_child": { "title": "Read permission for child records (for example items inside a main record).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccessTag": { "properties": { "id": { "title": "Primary key of the access tag.", "description": "Internal ID, used as the reference in access rights.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" } }, "type": "object" }, "AccessTag2": { "properties": { "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AccountingType": { "required": [ "name", "type" ], "properties": { "id": { "title": "Primary key of the accounting type.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the accounting type, for example course fee.", "type": "string" }, "cancelled_name": { "title": "Name used when an invoice of this type is canceled.", "type": "string" }, "type": { "title": "Type of the accounting type, for example invoice or credit note.", "type": "string" }, "deleted": { "title": "The accounting type is deleted.", "type": "boolean" }, "default_expense_category": { "title": "Standard-E\u00dcR-Kategorie f\u00fcr diesen Rechnungstyp (f\u00fcr Einnahmen-Mapping)", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] } }, "type": "object" }, "AdditionalUiField": { "properties": { "id": { "title": "Primary key of the additional field.", "description": "Internal ID.", "type": "integer" }, "entity_type": { "title": "Entity the field is added to, for example Person.", "type": "string" }, "field_type": { "title": "Input type of the field, for example text, number or date.", "type": "string" }, "field_group": { "title": "Group the field is shown in on the detail page.", "type": "string" }, "field_required": { "title": "The field must be filled in.", "type": "boolean" }, "field_order": { "title": "Sort order of the field inside its group.", "type": "integer" }, "field_scope": { "title": "Access scope needed to see or edit the field.", "type": "string" }, "field_access_type": { "title": "Access type needed to see or edit the field, for example read or write.", "type": "integer" }, "field_is_internal": { "title": "The field is only visible to internal users.", "type": "boolean" }, "field_name": { "title": "Technical name of the field.", "description": "Used as the key in the API.", "type": "string" }, "info_mode": { "title": "Display mode of the info text of the field.", "type": "string" }, "field_include_in_export": { "title": "The field is included in exports.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AdditionalUiFilter": { "properties": { "id": { "title": "Primary key of the additional filter.", "description": "Internal ID.", "type": "integer" }, "entity_type": { "title": "Entity the filter is added to, for example Person.", "type": "string" }, "filter_type": { "title": "Type of the filter, for example single value or range.", "type": "string" }, "filter_group": { "title": "Group the filter is shown in.", "type": "string" }, "filter_order": { "title": "Sort order of the filter inside its group.", "type": "integer" }, "filter_scope": { "title": "Access scope needed to use the filter.", "type": "string" }, "filter_condition": { "title": "Condition the filter applies, for example equals or contains.", "type": "string" }, "filter_access_type": { "title": "Access type needed to use the filter.", "type": "integer" }, "field_name": { "title": "Technical name of the field the filter works on.", "type": "string" }, "field_value": { "title": "Preset value of the filter.", "type": "string" }, "info_mode": { "title": "Display mode of the info text of the filter.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "AnalyticsConfig": { "properties": { "id": { "title": "Primary key of the analytics configuration.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "Whether analytics is active.", "type": "boolean" }, "tracking_token": { "title": "Tracking token of the analytics service.", "type": "string" }, "tag_manager_token": { "title": "Tag manager token of the analytics service.", "type": "string" } }, "type": "object" }, "ApiAccessToken": { "properties": { "id": { "title": "Primary key of the API access token.", "description": "Internal ID.", "type": "integer" }, "allow_super_admin": { "title": "Token may use super admin rights.", "description": "Only set when a super admin creates the token and requests allowSuperAdmin=true.", "type": "boolean" }, "allow_admin": { "title": "Token may use admin rights.", "type": "boolean" }, "allow_user": { "title": "Token may use regular user rights.", "type": "boolean" }, "is_dg": { "title": "Session flag copied from the session that created the token.", "type": "boolean" }, "token": { "title": "Short access token.", "description": "Returned when the token is created.", "type": "string" }, "allowed_path": { "title": "Path the token may call.", "description": "Restricts the token to API routes that start with this path.", "type": "string" }, "allowed_methods": { "title": "HTTP methods the token may use, for example GET or POST.", "type": "string" }, "rwe_scope": { "title": "Read, write and edit scopes the token may use.", "type": "string" }, "r_scope": { "title": "Read scopes the token may use.", "type": "string" }, "e_scope": { "title": "Edit scopes the token may use.", "type": "string" }, "w_scope": { "title": "Write scopes the token may use.", "type": "string" }, "scopes": { "title": "List of scopes the token may use.", "type": "object", "additionalProperties": true }, "token_version": { "title": "Version of the token format.", "description": "Used to invalidate old tokens.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "Attachment": { "properties": { "id": { "title": "Primary key of the attachment.", "description": "Internal ID.", "type": "integer" }, "filename": { "title": "Original file name.", "type": "string" }, "filesize": { "title": "Size of the file in bytes.", "type": "string" }, "mimetype": { "title": "MIME type of the file.", "type": "string" }, "createdbyusername": { "title": "Name of the user who uploaded the file, as text.", "type": "string" }, "created": { "title": "Point in time the attachment was created.", "type": "string", "format": "date-time" }, "googleid": { "title": "ID of the file in Google Drive.", "type": "string" }, "company": { "title": "Company the attachment belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "person": { "title": "Person the attachment belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "attached_person": { "title": "Person the attachment is attached to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "description": { "title": "Description of the attachment.", "type": "string" }, "scope": { "title": "Scope that controls who can see the attachment.", "type": "string" }, "public_keywords": { "title": "Keywords used to find public attachments.", "type": "string" }, "hide_in_list": { "title": "This property is used to hide this attachment in the list of attachments for the customer and global. Gives access to the attachment only via direct link", "type": "boolean" }, "disable_public_download": { "title": "This property is used to disable the public download of this attachment without a login", "type": "boolean" }, "ocr_document_type": { "title": "Document type recognized by OCR.", "type": "string" }, "ocr_from_name": { "title": "Sender name recognized by OCR.", "type": "string" }, "ocr_from_company": { "title": "Sender company recognized by OCR.", "type": "string" }, "ocr_from_address": { "title": "Sender address recognized by OCR.", "type": "string" }, "ocr_from_email": { "title": "Sender e-mail address recognized by OCR.", "type": "string" }, "ocr_from_phone": { "title": "Sender phone number recognized by OCR.", "type": "string" }, "ocr_to_name": { "title": "Recipient name recognized by OCR.", "type": "string" }, "ocr_to_company": { "title": "Recipient company recognized by OCR.", "type": "string" }, "ocr_to_address": { "title": "Recipient address recognized by OCR.", "type": "string" }, "ocr_to_email": { "title": "Recipient e-mail address recognized by OCR.", "type": "string" }, "ocr_to_phone": { "title": "Recipient phone number recognized by OCR.", "type": "string" }, "ocr_summary": { "title": "Summary of the document created by OCR.", "type": "string" }, "ocr_status": { "title": "OCR processing status: null=not processed, pending, processing, done, error", "type": "string" }, "ocr_error": { "title": "Reason of the last failed or incomplete OCR run, null when it went through", "type": "string" }, "ocr_processed_at": { "title": "Point in time OCR processing finished.", "type": "string", "format": "date-time" }, "virus_checked": { "title": "1 once the virus scan has passed for this file.", "description": "The scan runs in the background (AttachmentVirusScanCommand), so a freshly\nuploaded file starts at 0 and stays there until it was really checked. An\ninfected file never reaches 1 - it is deleted instead. UIs use this to decide\nwhether a file may be handed to a user, so it must stay false until proven\notherwise.", "type": "boolean" }, "virus_checked_at": { "title": "When the virus scan passed. Null while the file is still waiting.", "type": "string", "format": "date-time" } }, "type": "object" }, "Attachment10": { "properties": { "id": { "title": "Primary key of the attachment.", "description": "Internal ID.", "type": "integer" }, "filename": { "title": "Original file name.", "type": "string" }, "filesize": { "title": "Size of the file in bytes.", "type": "string" }, "mimetype": { "title": "MIME type of the file.", "type": "string" }, "createdbyusername": { "title": "Name of the user who uploaded the file, as text.", "type": "string" }, "created": { "title": "Point in time the attachment was created.", "type": "string", "format": "date-time" }, "googleid": { "title": "ID of the file in Google Drive.", "type": "string" }, "scope": { "title": "Scope that controls who can see the attachment.", "type": "string" }, "ocr_document_type": { "title": "Document type recognized by OCR.", "type": "string" }, "ocr_from_name": { "title": "Sender name recognized by OCR.", "type": "string" }, "ocr_from_company": { "title": "Sender company recognized by OCR.", "type": "string" }, "ocr_from_address": { "title": "Sender address recognized by OCR.", "type": "string" }, "ocr_from_email": { "title": "Sender e-mail address recognized by OCR.", "type": "string" }, "ocr_from_phone": { "title": "Sender phone number recognized by OCR.", "type": "string" }, "ocr_to_name": { "title": "Recipient name recognized by OCR.", "type": "string" }, "ocr_to_company": { "title": "Recipient company recognized by OCR.", "type": "string" }, "ocr_to_address": { "title": "Recipient address recognized by OCR.", "type": "string" }, "ocr_to_email": { "title": "Recipient e-mail address recognized by OCR.", "type": "string" }, "ocr_to_phone": { "title": "Recipient phone number recognized by OCR.", "type": "string" }, "ocr_summary": { "title": "Summary of the document created by OCR.", "type": "string" }, "ocr_status": { "title": "OCR processing status: null=not processed, pending, processing, done, error", "type": "string" }, "ocr_error": { "title": "Reason of the last failed or incomplete OCR run, null when it went through", "type": "string" }, "ocr_processed_at": { "title": "Point in time OCR processing finished.", "type": "string", "format": "date-time" }, "virus_checked": { "title": "1 once the virus scan has passed for this file.", "description": "The scan runs in the background (AttachmentVirusScanCommand), so a freshly\nuploaded file starts at 0 and stays there until it was really checked. An\ninfected file never reaches 1 - it is deleted instead. UIs use this to decide\nwhether a file may be handed to a user, so it must stay false until proven\notherwise.", "type": "boolean" }, "virus_checked_at": { "title": "When the virus scan passed. Null while the file is still waiting.", "type": "string", "format": "date-time" } }, "type": "object" }, "Attachment12": { "type": "object" }, "Attachment2": { "properties": { "id": { "title": "Primary key of the attachment.", "description": "Internal ID.", "type": "integer" }, "filename": { "title": "Original file name.", "type": "string" }, "filesize": { "title": "Size of the file in bytes.", "type": "string" }, "mimetype": { "title": "MIME type of the file.", "type": "string" }, "created": { "title": "Point in time the attachment was created.", "type": "string", "format": "date-time" }, "googledownloadlink": { "title": "Download link of the file in Google Drive.", "type": "string" }, "virus_checked": { "title": "1 once the virus scan has passed for this file.", "description": "The scan runs in the background (AttachmentVirusScanCommand), so a freshly\nuploaded file starts at 0 and stays there until it was really checked. An\ninfected file never reaches 1 - it is deleted instead. UIs use this to decide\nwhether a file may be handed to a user, so it must stay false until proven\notherwise.", "type": "boolean" } }, "type": "object" }, "Attachment22": { "properties": { "id": { "title": "Primary key of the attachment.", "description": "Internal ID.", "type": "integer" }, "filename": { "title": "Original file name.", "type": "string" }, "filesize": { "title": "Size of the file in bytes.", "type": "string" }, "mimetype": { "title": "MIME type of the file.", "type": "string" }, "createdbyusername": { "title": "Name of the user who uploaded the file, as text.", "type": "string" }, "created": { "title": "Point in time the attachment was created.", "type": "string", "format": "date-time" }, "googleid": { "title": "ID of the file in Google Drive.", "type": "string" }, "googledownloadlink": { "title": "Download link of the file in Google Drive.", "type": "string" }, "scope": { "title": "Scope that controls who can see the attachment.", "type": "string" }, "ocr_document_type": { "title": "Document type recognized by OCR.", "type": "string" }, "ocr_from_name": { "title": "Sender name recognized by OCR.", "type": "string" }, "ocr_from_company": { "title": "Sender company recognized by OCR.", "type": "string" }, "ocr_from_address": { "title": "Sender address recognized by OCR.", "type": "string" }, "ocr_from_email": { "title": "Sender e-mail address recognized by OCR.", "type": "string" }, "ocr_from_phone": { "title": "Sender phone number recognized by OCR.", "type": "string" }, "ocr_to_name": { "title": "Recipient name recognized by OCR.", "type": "string" }, "ocr_to_company": { "title": "Recipient company recognized by OCR.", "type": "string" }, "ocr_to_address": { "title": "Recipient address recognized by OCR.", "type": "string" }, "ocr_to_email": { "title": "Recipient e-mail address recognized by OCR.", "type": "string" }, "ocr_to_phone": { "title": "Recipient phone number recognized by OCR.", "type": "string" }, "ocr_summary": { "title": "Summary of the document created by OCR.", "type": "string" }, "ocr_status": { "title": "OCR processing status: null=not processed, pending, processing, done, error", "type": "string" }, "ocr_error": { "title": "Reason of the last failed or incomplete OCR run, null when it went through", "type": "string" }, "ocr_processed_at": { "title": "Point in time OCR processing finished.", "type": "string", "format": "date-time" }, "virus_checked": { "title": "1 once the virus scan has passed for this file.", "description": "The scan runs in the background (AttachmentVirusScanCommand), so a freshly\nuploaded file starts at 0 and stays there until it was really checked. An\ninfected file never reaches 1 - it is deleted instead. UIs use this to decide\nwhether a file may be handed to a user, so it must stay false until proven\notherwise.", "type": "boolean" }, "virus_checked_at": { "title": "When the virus scan passed. Null while the file is still waiting.", "type": "string", "format": "date-time" } }, "type": "object" }, "AttendanceList": { "properties": { "id": { "title": "Primary key of the attendance list.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the attendance list.", "description": "Used in the public link instead of the ID.", "type": "string" }, "name": { "title": "Name of the attendance list.", "type": "string" }, "description": { "title": "Internal description of the attendance list.", "type": "string" }, "public_link": { "title": "Public link to the attendance list, for example for an external form.", "type": "string" }, "public_imprint_link": { "title": "Link to the imprint shown on the public attendance form.", "type": "string" }, "public_privacy_link": { "title": "Link to the privacy policy shown on the public attendance form.", "type": "string" }, "public_additional_link_text": { "title": "Label of an additional link on the public attendance form.", "type": "string" }, "public_additional_link_url": { "title": "URL of the additional link on the public attendance form.", "type": "string" }, "description_external": { "title": "Description shown on the public attendance form.", "type": "string" }, "welcome_message": { "title": "Message shown before the form is filled in.", "type": "string" }, "completed_message": { "title": "Message shown after the form is completed.", "type": "string" }, "continue_message": { "title": "Message shown when the form is continued later.", "type": "string" }, "headline_external": { "title": "Headline shown on the public attendance form.", "type": "string" }, "image_url_external": { "title": "URL of the image shown on the public attendance form.", "type": "string" }, "form_type_external": { "title": "Type of the public form, for example check-in or check-out.", "type": "string" }, "ttl": { "title": "Time to live of the list in days, after which it is removed.", "type": "integer" }, "allow_older_dates": { "title": "Dates in the past may be entered.", "type": "boolean" }, "archived": { "title": "The attendance list is archived and no longer used.", "type": "boolean" }, "force_address": { "title": "The address must be entered on the public form.", "type": "boolean" }, "force_mail": { "title": "The e-mail address must be entered on the public form.", "type": "boolean" }, "force_phone": { "title": "The phone number must be entered on the public form.", "type": "boolean" }, "force_end_date": { "title": "The end date must be entered on the public form.", "type": "boolean" }, "force_start_date": { "title": "The start date must be entered on the public form.", "type": "boolean" }, "crm_company": { "title": "Company the attendance list belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "encrypt_data": { "title": "Personal data in the entries is stored encrypted.", "type": "boolean" }, "encrypt_ttl": { "title": "ttl in hours", "type": "integer" }, "encrypt_completed_ttl": { "title": "ttl in hours", "type": "integer" }, "close_ttl": { "title": "ttl in hours", "type": "integer" }, "th_people": { "title": "Threshold of people in the list for an alert.", "type": "integer" }, "th_people_recovered_vaccinated": { "title": "Threshold of recovered or vaccinated people for an alert.", "type": "integer" }, "th_people_not_recovered_vaccinated": { "title": "Threshold of people who are neither recovered nor vaccinated for an alert.", "type": "integer" }, "test_is_member": { "title": "Test setting: check if persons are members.", "type": "boolean" }, "test_event_booking": { "title": "Test setting: check if persons have an event booking.", "type": "boolean" }, "test_unified_category_ids": { "title": "Test setting: IDs of the unified categories to check.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "AttendanceListEntry": { "properties": { "id": { "title": "Primary key of the attendance list entry.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the entry.", "description": "Used instead of the ID.", "type": "string" }, "person_count": { "title": "Number of persons the entry stands for, for example a family.", "type": "integer" }, "start": { "title": "Time the participant arrived.", "type": "string", "format": "date-time" }, "end": { "title": "Time the participant left.", "type": "string", "format": "date-time" }, "completed": { "title": "The attendance entry is complete.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "BackupConfig": { "properties": { "id": { "title": "Primary key of the backup configuration.", "description": "Internal ID.", "type": "integer" }, "numberofbackupstokeep": { "title": "Number of backups to keep.", "type": "integer" }, "onlydatabasebackup": { "title": "Whether only the database is backed up.", "type": "boolean" }, "onlydownload": { "title": "Whether backups can only be downloaded.", "type": "boolean" }, "ht_password_content": { "title": "Content of the htpasswd file that protects the backups.", "type": "string" }, "active": { "title": "Whether the backup configuration is active.", "type": "boolean" }, "backup_type": { "title": "Type of the backup.", "type": "string" } }, "type": "object" }, "BankData": { "properties": { "id": { "title": "Primary key of the bank data.", "description": "Internal ID.", "type": "integer" }, "national_bank_number": { "title": "National bank number (bank code) of the bank.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "BaseBookable": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan of the room, also for the public serialization.", "type": "integer" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation4" }, "id": { "title": "Primary key of the bookable.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the bookable.", "description": "Used in links instead of the ID.", "type": "string" }, "bookable_type": { "title": "Type of the bookable, for example room, court or vehicle.", "type": "string" }, "floor_level": { "title": "Floor the bookable is on.", "type": "string" }, "floor_size": { "title": "Floor size in square meters.", "type": "integer" }, "pets_allowed": { "title": "Pets are allowed.", "type": "boolean" }, "barrier_free": { "title": "The bookable is barrier-free.", "type": "boolean" }, "cargo_volume": { "title": "Cargo volume in liters.", "type": "integer" }, "fuel_type": { "title": "Fuel type of the vehicle.", "type": "string" }, "seating_capacity": { "title": "Number of seats.", "type": "integer" }, "has_wait_list": { "title": "The bookable has a waiting list once it is fully booked.", "type": "boolean" }, "booking_limit": { "title": "Maximum number of bookings.", "type": "integer" }, "billing_mode": { "title": "How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at\nbooking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data)\nAlso in Default: the member app shows \"Nutzung erfassen\" only for usage-billed bookables.", "type": "string" }, "max_active_bookings_per_user": { "title": "Maximum number of active (future, not cancelled) self-service bookings one person may hold\non this bookable at the same time. Null = unlimited. Admin bookings are not limited.", "type": "integer" }, "max_advance_booking_hours": { "title": "Maximum number of hours a self-service booking may start in the future. Null = unlimited.\nAdmin bookings are not limited.", "type": "integer" }, "inventory_managed": { "title": "Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back,\nwith deposit and reminders. Only used while the setting event_inventory_enabled is on.", "type": "boolean" }, "inventory_deposit": { "title": "Deposit (Kaution) per piece asked on hand-over. Null = no deposit.", "type": "number", "format": "float" }, "new_booking_only_in_blocks": { "title": "New bookings are only possible in the defined blocks.", "type": "boolean" }, "new_booking_only_in_opening_hours": { "title": "New bookings are only possible during the opening hours.", "type": "boolean" }, "new_booking_only_in_self_service_opening_hours": { "title": "New bookings are only possible during the self-service opening hours.", "type": "boolean" }, "new_booking_limit_days_before": { "title": "Number of days before the start until which new bookings are possible.", "type": "integer" }, "new_booking_limit_stop_days_before": { "title": "Number of days before the start from which new bookings are closed.", "type": "integer" }, "delete_booking_hours_before": { "title": "Hours before the start until which a booking can be cancelled.", "type": "integer" }, "block_length": { "title": "Length of a booking block in minutes.", "type": "integer" }, "new_booking_min_length": { "title": "Minimum length of a new booking in minutes.", "type": "integer" }, "new_booking_max_length": { "title": "Maximum length of a new booking in minutes.", "type": "integer" }, "require_address": { "title": "The address must be entered when booking.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered when booking.", "type": "boolean" }, "require_billing": { "title": "Billing details must be entered when booking.", "type": "boolean" }, "require_booking_title": { "title": "A title must be entered when booking.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_age": { "title": "The age must be entered when booking.", "type": "boolean" }, "age_group": { "title": "Age group the bookable is intended for.", "type": "string" }, "min_age": { "title": "Minimum age in years.", "type": "integer" }, "max_age": { "title": "Maximum age in years.", "type": "integer" }, "age_tolerance": { "title": "Years by which the age may be outside the range and still be accepted.", "type": "integer" }, "counter_update_mode": { "title": "How the usage counters of the bookable are updated.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "opening_hours_monday": { "title": "Opening hours on Monday.", "type": "string" }, "opening_hours_tuesday": { "title": "Opening hours on Tuesday.", "type": "string" }, "opening_hours_wednesday": { "title": "Opening hours on Wednesday.", "type": "string" }, "opening_hours_thursday": { "title": "Opening hours on Thursday.", "type": "string" }, "opening_hours_friday": { "title": "Opening hours on Friday.", "type": "string" }, "opening_hours_saturday": { "title": "Opening hours on Saturday.", "type": "string" }, "opening_hours_sunday": { "title": "Opening hours on Sunday.", "type": "string" }, "self_service_opening_hours_monday": { "title": "Self-service opening hours on Monday.", "type": "string" }, "self_service_opening_hours_tuesday": { "title": "Self-service opening hours on Tuesday.", "type": "string" }, "self_service_opening_hours_wednesday": { "title": "Self-service opening hours on Wednesday.", "type": "string" }, "self_service_opening_hours_thursday": { "title": "Self-service opening hours on Thursday.", "type": "string" }, "self_service_opening_hours_friday": { "title": "Self-service opening hours on Friday.", "type": "string" }, "self_service_opening_hours_saturday": { "title": "Self-service opening hours on Saturday.", "type": "string" }, "self_service_opening_hours_sunday": { "title": "Self-service opening hours on Sunday.", "type": "string" }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true } }, "type": "object" }, "BaseBookable10": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan of the room, also for the public serialization.", "type": "integer" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "id": { "title": "Primary key of the bookable.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the bookable.", "description": "Used in links instead of the ID.", "type": "string" }, "bookable_type": { "title": "Type of the bookable, for example room, court or vehicle.", "type": "string" }, "floor_level": { "title": "Floor the bookable is on.", "type": "string" }, "floor_size": { "title": "Floor size in square meters.", "type": "integer" }, "pets_allowed": { "title": "Pets are allowed.", "type": "boolean" }, "barrier_free": { "title": "The bookable is barrier-free.", "type": "boolean" }, "cargo_volume": { "title": "Cargo volume in liters.", "type": "integer" }, "fuel_type": { "title": "Fuel type of the vehicle.", "type": "string" }, "seating_capacity": { "title": "Number of seats.", "type": "integer" }, "has_wait_list": { "title": "The bookable has a waiting list once it is fully booked.", "type": "boolean" }, "booking_limit": { "title": "Maximum number of bookings.", "type": "integer" }, "billing_mode": { "title": "How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at\nbooking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data)\nAlso in Default: the member app shows \"Nutzung erfassen\" only for usage-billed bookables.", "type": "string" }, "max_active_bookings_per_user": { "title": "Maximum number of active (future, not cancelled) self-service bookings one person may hold\non this bookable at the same time. Null = unlimited. Admin bookings are not limited.", "type": "integer" }, "max_advance_booking_hours": { "title": "Maximum number of hours a self-service booking may start in the future. Null = unlimited.\nAdmin bookings are not limited.", "type": "integer" }, "inventory_managed": { "title": "Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back,\nwith deposit and reminders. Only used while the setting event_inventory_enabled is on.", "type": "boolean" }, "inventory_deposit": { "title": "Deposit (Kaution) per piece asked on hand-over. Null = no deposit.", "type": "number", "format": "float" }, "require_address": { "title": "The address must be entered when booking.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered when booking.", "type": "boolean" }, "require_billing": { "title": "Billing details must be entered when booking.", "type": "boolean" }, "require_booking_title": { "title": "A title must be entered when booking.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_age": { "title": "The age must be entered when booking.", "type": "boolean" }, "counter_update_mode": { "title": "How the usage counters of the bookable are updated.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseBookable16": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan of the room, also for the public serialization.", "type": "integer" }, "id": { "title": "Primary key of the bookable.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the bookable.", "description": "Used in links instead of the ID.", "type": "string" }, "bookable_type": { "title": "Type of the bookable, for example room, court or vehicle.", "type": "string" }, "floor_level": { "title": "Floor the bookable is on.", "type": "string" }, "floor_size": { "title": "Floor size in square meters.", "type": "integer" }, "pets_allowed": { "title": "Pets are allowed.", "type": "boolean" }, "barrier_free": { "title": "The bookable is barrier-free.", "type": "boolean" }, "cargo_volume": { "title": "Cargo volume in liters.", "type": "integer" }, "fuel_type": { "title": "Fuel type of the vehicle.", "type": "string" }, "seating_capacity": { "title": "Number of seats.", "type": "integer" }, "has_wait_list": { "title": "The bookable has a waiting list once it is fully booked.", "type": "boolean" }, "booking_limit": { "title": "Maximum number of bookings.", "type": "integer" }, "billing_mode": { "title": "How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at\nbooking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data)\nAlso in Default: the member app shows \"Nutzung erfassen\" only for usage-billed bookables.", "type": "string" }, "max_active_bookings_per_user": { "title": "Maximum number of active (future, not cancelled) self-service bookings one person may hold\non this bookable at the same time. Null = unlimited. Admin bookings are not limited.", "type": "integer" }, "max_advance_booking_hours": { "title": "Maximum number of hours a self-service booking may start in the future. Null = unlimited.\nAdmin bookings are not limited.", "type": "integer" }, "inventory_managed": { "title": "Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back,\nwith deposit and reminders. Only used while the setting event_inventory_enabled is on.", "type": "boolean" }, "inventory_deposit": { "title": "Deposit (Kaution) per piece asked on hand-over. Null = no deposit.", "type": "number", "format": "float" }, "require_address": { "title": "The address must be entered when booking.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered when booking.", "type": "boolean" }, "require_billing": { "title": "Billing details must be entered when booking.", "type": "boolean" }, "require_booking_title": { "title": "A title must be entered when booking.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_age": { "title": "The age must be entered when booking.", "type": "boolean" }, "counter_update_mode": { "title": "How the usage counters of the bookable are updated.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseBookable17": { "properties": { "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } } }, "type": "object" }, "BaseBookable19": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan of the room, also for the public serialization.", "type": "integer" }, "id": { "title": "Primary key of the bookable.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the bookable.", "description": "Used in links instead of the ID.", "type": "string" }, "bookable_type": { "title": "Type of the bookable, for example room, court or vehicle.", "type": "string" }, "floor_level": { "title": "Floor the bookable is on.", "type": "string" }, "floor_size": { "title": "Floor size in square meters.", "type": "integer" }, "pets_allowed": { "title": "Pets are allowed.", "type": "boolean" }, "barrier_free": { "title": "The bookable is barrier-free.", "type": "boolean" }, "cargo_volume": { "title": "Cargo volume in liters.", "type": "integer" }, "fuel_type": { "title": "Fuel type of the vehicle.", "type": "string" }, "seating_capacity": { "title": "Number of seats.", "type": "integer" }, "has_wait_list": { "title": "The bookable has a waiting list once it is fully booked.", "type": "boolean" }, "booking_limit": { "title": "Maximum number of bookings.", "type": "integer" }, "billing_mode": { "title": "How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at\nbooking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data)\nAlso in Default: the member app shows \"Nutzung erfassen\" only for usage-billed bookables.", "type": "string" }, "max_active_bookings_per_user": { "title": "Maximum number of active (future, not cancelled) self-service bookings one person may hold\non this bookable at the same time. Null = unlimited. Admin bookings are not limited.", "type": "integer" }, "max_advance_booking_hours": { "title": "Maximum number of hours a self-service booking may start in the future. Null = unlimited.\nAdmin bookings are not limited.", "type": "integer" }, "inventory_managed": { "title": "Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back,\nwith deposit and reminders. Only used while the setting event_inventory_enabled is on.", "type": "boolean" }, "inventory_deposit": { "title": "Deposit (Kaution) per piece asked on hand-over. Null = no deposit.", "type": "number", "format": "float" }, "require_address": { "title": "The address must be entered when booking.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered when booking.", "type": "boolean" }, "require_billing": { "title": "Billing details must be entered when booking.", "type": "boolean" }, "require_booking_title": { "title": "A title must be entered when booking.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_age": { "title": "The age must be entered when booking.", "type": "boolean" }, "counter_update_mode": { "title": "How the usage counters of the bookable are updated.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage11" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseBookable3": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan of the room, also for the public serialization.", "type": "integer" }, "id": { "title": "Primary key of the bookable.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the bookable.", "description": "Used in links instead of the ID.", "type": "string" }, "bookable_type": { "title": "Type of the bookable, for example room, court or vehicle.", "type": "string" }, "floor_level": { "title": "Floor the bookable is on.", "type": "string" }, "floor_size": { "title": "Floor size in square meters.", "type": "integer" }, "pets_allowed": { "title": "Pets are allowed.", "type": "boolean" }, "barrier_free": { "title": "The bookable is barrier-free.", "type": "boolean" }, "cargo_volume": { "title": "Cargo volume in liters.", "type": "integer" }, "fuel_type": { "title": "Fuel type of the vehicle.", "type": "string" }, "seating_capacity": { "title": "Number of seats.", "type": "integer" }, "has_wait_list": { "title": "The bookable has a waiting list once it is fully booked.", "type": "boolean" }, "booking_limit": { "title": "Maximum number of bookings.", "type": "integer" }, "billing_mode": { "title": "How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at\nbooking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data)\nAlso in Default: the member app shows \"Nutzung erfassen\" only for usage-billed bookables.", "type": "string" }, "max_active_bookings_per_user": { "title": "Maximum number of active (future, not cancelled) self-service bookings one person may hold\non this bookable at the same time. Null = unlimited. Admin bookings are not limited.", "type": "integer" }, "max_advance_booking_hours": { "title": "Maximum number of hours a self-service booking may start in the future. Null = unlimited.\nAdmin bookings are not limited.", "type": "integer" }, "inventory_managed": { "title": "Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back,\nwith deposit and reminders. Only used while the setting event_inventory_enabled is on.", "type": "boolean" }, "inventory_deposit": { "title": "Deposit (Kaution) per piece asked on hand-over. Null = no deposit.", "type": "number", "format": "float" }, "require_address": { "title": "The address must be entered when booking.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered when booking.", "type": "boolean" }, "require_billing": { "title": "Billing details must be entered when booking.", "type": "boolean" }, "require_booking_title": { "title": "A title must be entered when booking.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_age": { "title": "The age must be entered when booking.", "type": "boolean" }, "counter_update_mode": { "title": "How the usage counters of the bookable are updated.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory16" } } }, "type": "object" }, "BaseBookable4": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan of the room, also for the public serialization.", "type": "integer" }, "id": { "title": "Primary key of the bookable.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the bookable.", "description": "Used in links instead of the ID.", "type": "string" }, "bookable_type": { "title": "Type of the bookable, for example room, court or vehicle.", "type": "string" }, "floor_level": { "title": "Floor the bookable is on.", "type": "string" }, "floor_size": { "title": "Floor size in square meters.", "type": "integer" }, "pets_allowed": { "title": "Pets are allowed.", "type": "boolean" }, "barrier_free": { "title": "The bookable is barrier-free.", "type": "boolean" }, "cargo_volume": { "title": "Cargo volume in liters.", "type": "integer" }, "fuel_type": { "title": "Fuel type of the vehicle.", "type": "string" }, "seating_capacity": { "title": "Number of seats.", "type": "integer" }, "has_wait_list": { "title": "The bookable has a waiting list once it is fully booked.", "type": "boolean" }, "booking_limit": { "title": "Maximum number of bookings.", "type": "integer" }, "billing_mode": { "title": "How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at\nbooking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data)\nAlso in Default: the member app shows \"Nutzung erfassen\" only for usage-billed bookables.", "type": "string" }, "max_active_bookings_per_user": { "title": "Maximum number of active (future, not cancelled) self-service bookings one person may hold\non this bookable at the same time. Null = unlimited. Admin bookings are not limited.", "type": "integer" }, "max_advance_booking_hours": { "title": "Maximum number of hours a self-service booking may start in the future. Null = unlimited.\nAdmin bookings are not limited.", "type": "integer" }, "inventory_managed": { "title": "Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back,\nwith deposit and reminders. Only used while the setting event_inventory_enabled is on.", "type": "boolean" }, "inventory_deposit": { "title": "Deposit (Kaution) per piece asked on hand-over. Null = no deposit.", "type": "number", "format": "float" }, "require_address": { "title": "The address must be entered when booking.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered when booking.", "type": "boolean" }, "require_billing": { "title": "Billing details must be entered when booking.", "type": "boolean" }, "require_booking_title": { "title": "A title must be entered when booking.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_age": { "title": "The age must be entered when booking.", "type": "boolean" }, "counter_update_mode": { "title": "How the usage counters of the bookable are updated.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "self_service_type": { "title": "Type of the self-service option.", "type": "string" }, "arslist_self_service": { "title": "Access rights list that controls the self-service option.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage2" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseBookable9": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan of the room, also for the public serialization.", "type": "integer" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation8" }, "id": { "title": "Primary key of the bookable.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the bookable.", "description": "Used in links instead of the ID.", "type": "string" }, "bookable_type": { "title": "Type of the bookable, for example room, court or vehicle.", "type": "string" }, "floor_level": { "title": "Floor the bookable is on.", "type": "string" }, "floor_size": { "title": "Floor size in square meters.", "type": "integer" }, "pets_allowed": { "title": "Pets are allowed.", "type": "boolean" }, "barrier_free": { "title": "The bookable is barrier-free.", "type": "boolean" }, "cargo_volume": { "title": "Cargo volume in liters.", "type": "integer" }, "fuel_type": { "title": "Fuel type of the vehicle.", "type": "string" }, "seating_capacity": { "title": "Number of seats.", "type": "integer" }, "has_wait_list": { "title": "The bookable has a waiting list once it is fully booked.", "type": "boolean" }, "booking_limit": { "title": "Maximum number of bookings.", "type": "integer" }, "billing_mode": { "title": "How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at\nbooking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data)\nAlso in Default: the member app shows \"Nutzung erfassen\" only for usage-billed bookables.", "type": "string" }, "max_active_bookings_per_user": { "title": "Maximum number of active (future, not cancelled) self-service bookings one person may hold\non this bookable at the same time. Null = unlimited. Admin bookings are not limited.", "type": "integer" }, "max_advance_booking_hours": { "title": "Maximum number of hours a self-service booking may start in the future. Null = unlimited.\nAdmin bookings are not limited.", "type": "integer" }, "inventory_managed": { "title": "Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back,\nwith deposit and reminders. Only used while the setting event_inventory_enabled is on.", "type": "boolean" }, "inventory_deposit": { "title": "Deposit (Kaution) per piece asked on hand-over. Null = no deposit.", "type": "number", "format": "float" }, "require_address": { "title": "The address must be entered when booking.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered when booking.", "type": "boolean" }, "require_billing": { "title": "Billing details must be entered when booking.", "type": "boolean" }, "require_booking_title": { "title": "A title must be entered when booking.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_age": { "title": "The age must be entered when booking.", "type": "boolean" }, "counter_update_mode": { "title": "How the usage counters of the bookable are updated.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true } }, "type": "object" }, "BaseBookableBookableType": { "properties": { "id": { "title": "Identifier of the bookable type.", "description": "For example room or vehicle.", "type": "string" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "name": { "title": "Name of the bookable type.", "type": "string" }, "view_order": { "title": "Sort order of the bookable type in lists.", "type": "integer" }, "menu_name": { "title": "Name of the menu entry for the bookable type.", "type": "string" }, "menu_icon": { "title": "Icon of the menu entry for the bookable type.", "type": "string" }, "show_admin_menu": { "title": "Show the bookable type in the admin menu.", "type": "boolean" }, "show_admin_calendar": { "title": "Show the bookable type in the admin calendar.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseBookableBookableType2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseBookableComponent": { "properties": { "id": { "title": "Primary key of the component.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the component.", "description": "Used instead of the ID.", "type": "string" }, "maintenance_due_date": { "title": "Date the next maintenance is due.", "type": "string", "format": "date-time" }, "counter_threshold": { "title": "Counter value at which maintenance is due.", "type": "string" }, "counter_unit": { "title": "Unit of the counter, for example hours or kilometers.", "type": "string" }, "base_bookable": { "title": "Bookable the component belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookable16" } ] }, "expiry_warning_sent_at": { "title": "Set when an expiry warning was sent; cleared when the due date or threshold changes\nso the warning re-arms (see BookableComponentExpiryCheckCommand)", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "BaseBookableComponent2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseBookableUsageCounter": { "properties": { "id": { "title": "Primary key of the usage counter.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the usage counter.", "description": "Used instead of the ID.", "type": "string" }, "counter_value": { "title": "Value of the usage counter.", "type": "number", "format": "float" }, "counter_unit": { "title": "Unit of the usage counter, for example hours or pieces.", "type": "string" }, "use_real_usage_data": { "title": "The counter uses the recorded real usage instead of the planned value.", "type": "boolean" }, "base_bookable": { "title": "Bookable the counter belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookable16" } ] }, "base_bookable_component": { "title": "Component of the bookable the counter belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookableComponent" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "BaseBookableUsageCounter2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseBooking": { "properties": { "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "auto_invoice": { "title": "Invoices for this booking are created automatically.", "type": "boolean" }, "waiting": { "title": "The booking is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The booking is confirmed.", "type": "boolean" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the booking was cancelled.", "type": "string" }, "deletion_date": { "title": "When the booking was cancelled, set by setDeleted() - null while active and for bookings\ncancelled before this field existed", "type": "string", "format": "date-time" }, "billed": { "title": "The booking was billed.", "type": "boolean" }, "invoice": { "title": "Invoice the booking was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice22" } ] }, "performing_person": { "title": "CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the booking, for example a course unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType4" } ] }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "event_type": { "title": "denormalized event type from BaseEvent for fast filtering", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the booking", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the booking", "type": "integer" }, "booking_schedule": { "title": "Booking schedule the booking was generated from.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule4" } ] }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "base_booking_group": { "title": "Booking group the booking belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup11" } ] }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "trainer_availability": { "title": "The availability (a BaseBooking of type AVAILABILITY) of the trainer that was picked for this\nbooking. Only used when the content type of the booking asks for a trainer selection.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking" } ] }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBooking10": { "properties": { "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "performing_person": { "title": "CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBooking11": { "properties": { "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent20" }, "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "waiting": { "title": "The booking is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The booking is confirmed.", "type": "boolean" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the booking was cancelled.", "type": "string" }, "deletion_date": { "title": "When the booking was cancelled, set by setDeleted() - null while active and for bookings\ncancelled before this field existed", "type": "string", "format": "date-time" }, "performing_person": { "title": "CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson59" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson59" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the booking, for example a course unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType10" } ] }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "event_type": { "title": "denormalized event type from BaseEvent for fast filtering", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the booking", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the booking", "type": "integer" }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "trainer_availability": { "title": "The availability (a BaseBooking of type AVAILABILITY) of the trainer that was picked for this\nbooking. Only used when the content type of the booking asks for a trainer selection.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking11" } ] }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson59" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson59" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson59" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBooking12": { "properties": { "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "BaseBooking13": { "properties": { "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBooking14": { "properties": { "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "BaseBooking2": { "properties": { "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent13" }, "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "waiting": { "title": "The booking is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The booking is confirmed.", "type": "boolean" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the booking was cancelled.", "type": "string" }, "deletion_date": { "title": "When the booking was cancelled, set by setDeleted() - null while active and for bookings\ncancelled before this field existed", "type": "string", "format": "date-time" }, "performing_person": { "title": "CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson50" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson50" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "event_type": { "title": "denormalized event type from BaseEvent for fast filtering", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the booking", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the booking", "type": "integer" }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson50" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson50" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson50" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBooking20": { "type": "object" }, "BaseBooking21": { "properties": { "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "base_event": { "title": "Event the entity belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent21" } ] } }, "type": "object" }, "BaseBooking22": { "properties": { "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "base_event": { "title": "Event the entity belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent22" } ] }, "name": { "title": "Name of the entity.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "BaseBooking24": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "BaseBooking3": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany" }, "user": { "$ref": "#\/components\/schemas\/User14" }, "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "auto_invoice": { "title": "Invoices for this booking are created automatically.", "type": "boolean" }, "waiting": { "title": "The booking is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The booking is confirmed.", "type": "boolean" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the booking was cancelled.", "type": "string" }, "deletion_date": { "title": "When the booking was cancelled, set by setDeleted() - null while active and for bookings\ncancelled before this field existed", "type": "string", "format": "date-time" }, "billed": { "title": "The booking was billed.", "type": "boolean" }, "invoice": { "title": "Invoice the booking was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice23" } ] }, "performing_person": { "title": "CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the booking, for example a course unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType5" } ] }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "event_type": { "title": "denormalized event type from BaseEvent for fast filtering", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the booking", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the booking", "type": "integer" }, "booking_schedule": { "title": "Booking schedule the booking was generated from.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule4" } ] }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "base_booking_group": { "title": "Booking group the booking belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup" } ] }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "trainer_availability": { "title": "The availability (a BaseBooking of type AVAILABILITY) of the trainer that was picked for this\nbooking. Only used when the content type of the booking asks for a trainer selection.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking3" } ] }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBooking5": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent18" }, "user": { "$ref": "#\/components\/schemas\/User14" }, "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "auto_invoice": { "title": "Invoices for this booking are created automatically.", "type": "boolean" }, "waiting": { "title": "The booking is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The booking is confirmed.", "type": "boolean" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the booking was cancelled.", "type": "string" }, "deletion_date": { "title": "When the booking was cancelled, set by setDeleted() - null while active and for bookings\ncancelled before this field existed", "type": "string", "format": "date-time" }, "billed": { "title": "The booking was billed.", "type": "boolean" }, "invoice": { "title": "Invoice the booking was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice24" } ] }, "performing_person": { "title": "CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the booking, for example a course unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType6" } ] }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "event_type": { "title": "denormalized event type from BaseEvent for fast filtering", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the booking", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the booking", "type": "integer" }, "booking_schedule": { "title": "Booking schedule the booking was generated from.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule6" } ] }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "base_booking_group": { "title": "Booking group the booking belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup3" } ] }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "trainer_availability": { "title": "The availability (a BaseBooking of type AVAILABILITY) of the trainer that was picked for this\nbooking. Only used when the content type of the booking asks for a trainer selection.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking5" } ] }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBooking6": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent18" }, "user": { "$ref": "#\/components\/schemas\/User14" }, "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "auto_invoice": { "title": "Invoices for this booking are created automatically.", "type": "boolean" }, "waiting": { "title": "The booking is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The booking is confirmed.", "type": "boolean" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the booking was cancelled.", "type": "string" }, "deletion_date": { "title": "When the booking was cancelled, set by setDeleted() - null while active and for bookings\ncancelled before this field existed", "type": "string", "format": "date-time" }, "attachments": { "title": "Files attached to this booking in the administration (contracts, room lists, mails saved as PDF, ...)", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "billed": { "title": "The booking was billed.", "type": "boolean" }, "invoice": { "title": "Invoice the booking was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice25" } ] }, "performing_person": { "title": "CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the booking, for example a course unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType7" } ] }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "event_type": { "title": "denormalized event type from BaseEvent for fast filtering", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the booking", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the booking", "type": "integer" }, "booking_schedule": { "title": "Booking schedule the booking was generated from.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule7" } ] }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "base_booking_group": { "title": "Booking group the booking belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup4" } ] }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "trainer_availability": { "title": "The availability (a BaseBooking of type AVAILABILITY) of the trainer that was picked for this\nbooking. Only used when the content type of the booking asks for a trainer selection.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking6" } ] }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBooking7": { "properties": { "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "auto_invoice": { "title": "Invoices for this booking are created automatically.", "type": "boolean" }, "waiting": { "title": "The booking is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The booking is confirmed.", "type": "boolean" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the booking was cancelled.", "type": "string" }, "deletion_date": { "title": "When the booking was cancelled, set by setDeleted() - null while active and for bookings\ncancelled before this field existed", "type": "string", "format": "date-time" }, "billed": { "title": "The booking was billed.", "type": "boolean" }, "invoice": { "title": "Invoice the booking was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice26" } ] }, "performing_person": { "title": "CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the booking, for example a course unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType8" } ] }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "event_type": { "title": "denormalized event type from BaseEvent for fast filtering", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the booking", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the booking", "type": "integer" }, "booking_schedule": { "title": "Booking schedule the booking was generated from.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule4" } ] }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "base_booking_group": { "title": "Booking group the booking belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup12" } ] }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "trainer_availability": { "title": "The availability (a BaseBooking of type AVAILABILITY) of the trainer that was picked for this\nbooking. Only used when the content type of the booking asks for a trainer selection.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking7" } ] }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBooking8": { "properties": { "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent20" }, "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "waiting": { "title": "The booking is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The booking is confirmed.", "type": "boolean" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the booking was cancelled.", "type": "string" }, "deletion_date": { "title": "When the booking was cancelled, set by setDeleted() - null while active and for bookings\ncancelled before this field existed", "type": "string", "format": "date-time" }, "performing_person": { "title": "CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson59" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson59" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "event_type": { "title": "denormalized event type from BaseEvent for fast filtering", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the booking", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the booking", "type": "integer" }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson59" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson59" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson59" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBooking9": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany" }, "id": { "title": "Primary key of the booking.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the booking, for example normal or substitution.", "type": "string" }, "booking_status": { "title": "Status of the booking, for example planned, done or cancelled.", "type": "string" }, "auto_invoice": { "title": "Invoices for this booking are created automatically.", "type": "boolean" }, "waiting": { "title": "The booking is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The booking is confirmed.", "type": "boolean" }, "external": { "title": "The booking was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the booking was cancelled.", "type": "string" }, "deletion_date": { "title": "When the booking was cancelled, set by setDeleted() - null while active and for bookings\ncancelled before this field existed", "type": "string", "format": "date-time" }, "billed": { "title": "The booking was billed.", "type": "boolean" }, "invoice": { "title": "Invoice the booking was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice27" } ] }, "performing_person": { "title": "CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the booking, for example a course unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType9" } ] }, "modified_time": { "title": "The time of the booking was changed after it was created.", "type": "boolean" }, "modified_location": { "title": "The location of the booking was changed after it was created.", "type": "boolean" }, "modified_bookable": { "title": "The bookable of the booking was changed after it was created.", "type": "boolean" }, "modified_performing_person": { "title": "The leader of the booking was changed after it was created.", "type": "boolean" }, "event_type": { "title": "denormalized event type from BaseEvent for fast filtering", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the booking", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the booking", "type": "integer" }, "booking_schedule": { "title": "Booking schedule the booking was generated from.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventBookingSchedule4" } ] }, "searching_for_performing_person": { "title": "A leader for the booking is still being searched for.", "type": "boolean" }, "base_booking_group": { "title": "Booking group the booking belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup13" } ] }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "trainer_availability": { "title": "The availability (a BaseBooking of type AVAILABILITY) of the trainer that was picked for this\nbooking. Only used when the content type of the booking asks for a trainer selection.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking9" } ] }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBookingGroup": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany" }, "user": { "$ref": "#\/components\/schemas\/User14" }, "id": { "title": "Primary key of the booking group.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking group.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking group.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the bookings in the group.", "type": "string" }, "booking_status": { "title": "Status of the bookings in the group.", "type": "string" }, "auto_invoice": { "title": "Invoices for the group are created automatically.", "type": "boolean" }, "waiting": { "title": "The group is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The group is confirmed.", "type": "boolean" }, "external": { "title": "The group was made by an external party.", "type": "boolean" }, "billed": { "title": "The group was billed.", "type": "boolean" }, "billing_type": { "title": "Billing type of the group, for example per booking or per group.", "type": "string" }, "invoice": { "title": "Invoice the group was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice23" } ] }, "performing_person": { "title": "CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the bookings in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType5" } ] }, "base_bookings": { "title": "Bookings that belong to the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking3" } }, "people_count": { "title": "Number of people in the group.", "type": "integer" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "deletion_reason": { "title": "Reason for the deletion.", "type": "string" }, "deletion_date": { "title": "Point in time of the deletion.", "type": "string", "format": "date-time" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBookingGroup10": { "properties": { "id": { "title": "Primary key of the booking group.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking group.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking group.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the bookings in the group.", "type": "string" }, "booking_status": { "title": "Status of the bookings in the group.", "type": "string" }, "external": { "title": "The group was made by an external party.", "type": "boolean" }, "billing_type": { "title": "Billing type of the group, for example per booking or per group.", "type": "string" }, "people_count": { "title": "Number of people in the group.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "deletion_reason": { "title": "Reason for the deletion.", "type": "string" }, "deletion_date": { "title": "Point in time of the deletion.", "type": "string", "format": "date-time" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBookingGroup11": { "properties": { "id": { "title": "Primary key of the booking group.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking group.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking group.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the bookings in the group.", "type": "string" }, "booking_status": { "title": "Status of the bookings in the group.", "type": "string" }, "auto_invoice": { "title": "Invoices for the group are created automatically.", "type": "boolean" }, "waiting": { "title": "The group is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The group is confirmed.", "type": "boolean" }, "external": { "title": "The group was made by an external party.", "type": "boolean" }, "billed": { "title": "The group was billed.", "type": "boolean" }, "billing_type": { "title": "Billing type of the group, for example per booking or per group.", "type": "string" }, "invoice": { "title": "Invoice the group was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice22" } ] }, "performing_person": { "title": "CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the bookings in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType4" } ] }, "base_bookings": { "title": "Bookings that belong to the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking" } }, "people_count": { "title": "Number of people in the group.", "type": "integer" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "deletion_reason": { "title": "Reason for the deletion.", "type": "string" }, "deletion_date": { "title": "Point in time of the deletion.", "type": "string", "format": "date-time" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBookingGroup12": { "properties": { "id": { "title": "Primary key of the booking group.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking group.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking group.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the bookings in the group.", "type": "string" }, "booking_status": { "title": "Status of the bookings in the group.", "type": "string" }, "auto_invoice": { "title": "Invoices for the group are created automatically.", "type": "boolean" }, "waiting": { "title": "The group is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The group is confirmed.", "type": "boolean" }, "external": { "title": "The group was made by an external party.", "type": "boolean" }, "billed": { "title": "The group was billed.", "type": "boolean" }, "billing_type": { "title": "Billing type of the group, for example per booking or per group.", "type": "string" }, "invoice": { "title": "Invoice the group was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice26" } ] }, "performing_person": { "title": "CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the bookings in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType8" } ] }, "base_bookings": { "title": "Bookings that belong to the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking7" } }, "people_count": { "title": "Number of people in the group.", "type": "integer" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "deletion_reason": { "title": "Reason for the deletion.", "type": "string" }, "deletion_date": { "title": "Point in time of the deletion.", "type": "string", "format": "date-time" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBookingGroup13": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany" }, "id": { "title": "Primary key of the booking group.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking group.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking group.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the bookings in the group.", "type": "string" }, "booking_status": { "title": "Status of the bookings in the group.", "type": "string" }, "auto_invoice": { "title": "Invoices for the group are created automatically.", "type": "boolean" }, "waiting": { "title": "The group is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The group is confirmed.", "type": "boolean" }, "external": { "title": "The group was made by an external party.", "type": "boolean" }, "billed": { "title": "The group was billed.", "type": "boolean" }, "billing_type": { "title": "Billing type of the group, for example per booking or per group.", "type": "string" }, "invoice": { "title": "Invoice the group was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice27" } ] }, "performing_person": { "title": "CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the bookings in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType9" } ] }, "base_bookings": { "title": "Bookings that belong to the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking9" } }, "people_count": { "title": "Number of people in the group.", "type": "integer" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "deletion_reason": { "title": "Reason for the deletion.", "type": "string" }, "deletion_date": { "title": "Point in time of the deletion.", "type": "string", "format": "date-time" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBookingGroup2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "deletion_reason": { "title": "Reason for the deletion.", "type": "string" }, "deletion_date": { "title": "Point in time of the deletion.", "type": "string", "format": "date-time" } }, "type": "object" }, "BaseBookingGroup3": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "user": { "$ref": "#\/components\/schemas\/User14" }, "id": { "title": "Primary key of the booking group.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking group.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking group.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the bookings in the group.", "type": "string" }, "booking_status": { "title": "Status of the bookings in the group.", "type": "string" }, "auto_invoice": { "title": "Invoices for the group are created automatically.", "type": "boolean" }, "waiting": { "title": "The group is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The group is confirmed.", "type": "boolean" }, "external": { "title": "The group was made by an external party.", "type": "boolean" }, "billed": { "title": "The group was billed.", "type": "boolean" }, "billing_type": { "title": "Billing type of the group, for example per booking or per group.", "type": "string" }, "invoice": { "title": "Invoice the group was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice24" } ] }, "performing_person": { "title": "CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the bookings in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType6" } ] }, "base_bookings": { "title": "Bookings that belong to the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking5" } }, "people_count": { "title": "Number of people in the group.", "type": "integer" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "deletion_reason": { "title": "Reason for the deletion.", "type": "string" }, "deletion_date": { "title": "Point in time of the deletion.", "type": "string", "format": "date-time" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBookingGroup4": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "user": { "$ref": "#\/components\/schemas\/User14" }, "id": { "title": "Primary key of the booking group.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the booking group.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the booking group.", "type": "string", "format": "date-time" }, "booking_type": { "title": "Type of the bookings in the group.", "type": "string" }, "booking_status": { "title": "Status of the bookings in the group.", "type": "string" }, "auto_invoice": { "title": "Invoices for the group are created automatically.", "type": "boolean" }, "waiting": { "title": "The group is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The group is confirmed.", "type": "boolean" }, "external": { "title": "The group was made by an external party.", "type": "boolean" }, "billed": { "title": "The group was billed.", "type": "boolean" }, "billing_type": { "title": "Billing type of the group, for example per booking or per group.", "type": "string" }, "invoice": { "title": "Invoice the group was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice25" } ] }, "performing_person": { "title": "CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant": { "title": "CRM person who participates in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "participant_company_name": { "title": "Company name of the participant.", "type": "string" }, "participant_name": { "title": "Name of the participant.", "type": "string" }, "participant_first_name": { "title": "First name of the participant.", "type": "string" }, "participant_last_name": { "title": "Last name of the participant.", "type": "string" }, "participant_address_street_level": { "title": "Street and house number of the participant.", "type": "string" }, "participant_address_zip": { "title": "Postal code of the participant.", "type": "string" }, "participant_address_city": { "title": "City of the participant.", "type": "string" }, "participant_address_country": { "title": "Country of the participant.", "type": "string" }, "participant_number": { "title": "Member or customer number of the participant.", "type": "string" }, "participant_email": { "title": "E-mail address of the participant.", "type": "string" }, "participant_birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "content_type": { "title": "Content type of the bookings in the group.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType7" } ] }, "base_bookings": { "title": "Bookings that belong to the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBooking6" } }, "attachments": { "title": "Files attached to this booking group in the administration (contracts, room lists, mails saved as PDF, ...)", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "people_count": { "title": "Number of people in the group.", "type": "integer" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "deletion_reason": { "title": "Reason for the deletion.", "type": "string" }, "deletion_date": { "title": "Point in time of the deletion.", "type": "string", "format": "date-time" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseBookingRealUsage": { "properties": { "id": { "title": "Primary key of the real usage entry.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the real usage entry.", "description": "Used instead of the ID.", "type": "string" }, "start_value": { "title": "Counter value at the start of the booking, for example the odometer.", "type": "number", "format": "float" }, "stop_value": { "title": "Counter value at the end of the booking.", "type": "number", "format": "float" }, "duration": { "title": "Duration of the usage in minutes.", "type": "integer" }, "kilometers": { "title": "Kilometers driven.", "type": "number", "format": "float" }, "refueled_gas": { "title": "Amount of fuel refueled.", "type": "number", "format": "float" }, "refueled_oil": { "title": "Amount of oil refueled.", "type": "number", "format": "float" }, "gas_type": { "title": "Type of fuel refueled.", "type": "string" }, "is_training": { "title": "The usage was a training.", "type": "boolean" }, "billing_type": { "title": "Billing type of the usage.", "type": "integer" }, "base_booking": { "title": "Booking the usage belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "trainer": { "title": "CRM person who used the bookable.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseBookingRealUsage2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseBookingRealUsageSection": { "properties": { "id": { "title": "Primary key of the usage section.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the usage section.", "description": "Used instead of the ID.", "type": "string" }, "start_location": { "title": "Location where the section started.", "type": "string" }, "start_time": { "title": "Start time of the section.", "type": "string", "format": "date-time" }, "start_section_time": { "title": "Start time of the section within the usage.", "type": "string", "format": "date-time" }, "end_location": { "title": "Location where the section ended.", "type": "string" }, "end_time": { "title": "End time of the section.", "type": "string", "format": "date-time" }, "end_section_time": { "title": "End time of the section within the usage.", "type": "string", "format": "date-time" }, "number_of_landings": { "title": "Number of landings in the section.", "type": "integer" }, "base_booking_real_usage": { "title": "Real usage the section belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingRealUsage" } ] }, "start_base_location": { "title": "Master record for startLocation (e.g. airport, matched via shortIdentifier = ICAO code)", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "end_base_location": { "title": "Master record for endLocation (e.g. airport, matched via shortIdentifier = ICAO code)", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseBookingRealUsageSection2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseBookingTest": { "properties": { "booking_allowed": { "type": "boolean" }, "booking_waitlist_allowed": { "type": "boolean" }, "booking_explicitly_disabled": { "type": "boolean" }, "booking_requires_login": { "type": "boolean" } }, "type": "object" }, "BaseEvent": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the event.", "description": "Used in links and QR codes instead of the ID.", "type": "string" }, "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_keywords": { "title": "Keywords shown in the public event listing.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "age_group": { "title": "Age group the event is intended for, for example children or adults.", "type": "string" }, "min_age": { "title": "Minimum age in years of participants.", "type": "integer" }, "max_age": { "title": "Maximum age in years of participants.", "type": "integer" }, "min_age_months": { "title": "Minimum age in months of participants, for events for infants.", "type": "integer" }, "max_age_months": { "title": "Maximum age in months of participants, for events for infants.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level of participants.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level of participants.", "type": "integer" }, "age_tolerance": { "title": "Years by which participants may be outside the age range and still sign up.", "type": "integer" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "event_people_recovered_vaccinated_limit": { "title": "Maximum number of recovered or vaccinated participants.", "type": "integer" }, "event_people_not_recovered_vaccinated_limit": { "title": "Maximum number of participants who are neither recovered nor vaccinated.", "type": "integer" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "sign_up_limit_days_before": { "title": "Number of days before the start until which sign-ups are possible.", "type": "integer" }, "sign_up_limit_stop_days_before": { "title": "Number of days before the start from which sign-ups are closed.", "type": "integer" }, "sign_up_delete_hours_before": { "title": "Hours before the start until which a participant can cancel the sign-up.", "type": "integer" }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "copy_main_sign_ups_to_booking": { "title": "Sign-ups of the main event are copied to the generated bookings.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_rank_by": { "title": "Wertung nach Netto- (NET) oder Bruttozeit (GROSS).", "type": "string" }, "timing_min_lap_seconds": { "title": "Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.", "type": "integer" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true }, "unified_tag_ids": { "title": "IDs of the unified tags.", "type": "object", "additionalProperties": true }, "unified_tag_names": { "title": "Names of the unified tags.", "type": "object", "additionalProperties": true }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent10": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" } }, "type": "object" }, "BaseEvent11": { "type": "object" }, "BaseEvent12": { "type": "object" }, "BaseEvent13": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the event.", "description": "Used in links and QR codes instead of the ID.", "type": "string" }, "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_keywords": { "title": "Keywords shown in the public event listing.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "age_group": { "title": "Age group the event is intended for, for example children or adults.", "type": "string" }, "min_age": { "title": "Minimum age in years of participants.", "type": "integer" }, "max_age": { "title": "Maximum age in years of participants.", "type": "integer" }, "min_age_months": { "title": "Minimum age in months of participants, for events for infants.", "type": "integer" }, "max_age_months": { "title": "Maximum age in months of participants, for events for infants.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level of participants.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level of participants.", "type": "integer" }, "age_tolerance": { "title": "Years by which participants may be outside the age range and still sign up.", "type": "integer" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "event_people_recovered_vaccinated_limit": { "title": "Maximum number of recovered or vaccinated participants.", "type": "integer" }, "event_people_not_recovered_vaccinated_limit": { "title": "Maximum number of participants who are neither recovered nor vaccinated.", "type": "integer" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "sign_up_limit_days_before": { "title": "Number of days before the start until which sign-ups are possible.", "type": "integer" }, "sign_up_limit_stop_days_before": { "title": "Number of days before the start from which sign-ups are closed.", "type": "integer" }, "sign_up_delete_hours_before": { "title": "Hours before the start until which a participant can cancel the sign-up.", "type": "integer" }, "performing_person": { "title": "CRM person who leads the event, for example the trainer.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "copy_main_sign_ups_to_booking": { "title": "Sign-ups of the main event are copied to the generated bookings.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_rank_by": { "title": "Wertung nach Netto- (NET) oder Bruttozeit (GROSS).", "type": "string" }, "timing_min_lap_seconds": { "title": "Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.", "type": "integer" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent14": { "properties": { "moments_share_password_set": { "title": "Virtual serializer property: is the moments gallery shared (= password set)?", "type": "boolean" }, "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "token": { "title": "The public token, needed by the admin app to show the live links.", "description": "Used in links and QR codes instead of the ID.", "type": "string" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "moments_token": { "title": "Anonymous moments token for the login-free guest access (QR code target).", "description": "Separate from the general event token on purpose.", "type": "string" }, "public_keywords": { "title": "Keywords shown in the public event listing.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "age_group": { "title": "Age group the event is intended for, for example children or adults.", "type": "string" }, "min_age": { "title": "Minimum age in years of participants.", "type": "integer" }, "max_age": { "title": "Maximum age in years of participants.", "type": "integer" }, "min_age_months": { "title": "Minimum age in months of participants, for events for infants.", "type": "integer" }, "max_age_months": { "title": "Maximum age in months of participants, for events for infants.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level of participants.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level of participants.", "type": "integer" }, "age_tolerance": { "title": "Years by which participants may be outside the age range and still sign up.", "type": "integer" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "event_people_recovered_vaccinated_limit": { "title": "Maximum number of recovered or vaccinated participants.", "type": "integer" }, "event_people_not_recovered_vaccinated_limit": { "title": "Maximum number of participants who are neither recovered nor vaccinated.", "type": "integer" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "mail_wait_list_text": { "title": "Short text of the e-mail sent when a participant is put on the waiting list.", "type": "string" }, "mail_wait_list_long_text": { "title": "Long text of the e-mail sent when a participant is put on the waiting list.", "type": "string" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "wait_list_confirmation_hours": { "title": "Hours a participant has to confirm a place from the waiting list.", "type": "integer" }, "wait_list_priority_mode": { "type": "string" }, "absence_warning_threshold": { "type": "integer" }, "absence_auto_delete_threshold": { "type": "integer" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "trial_policy": { "title": "Trial rule of this event; null = the rule of the category or the default rule", "oneOf": [ { "$ref": "#\/components\/schemas\/TrialPolicy5" } ] }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "sign_up_limit_days_before": { "title": "Number of days before the start until which sign-ups are possible.", "type": "integer" }, "sign_up_limit_stop_days_before": { "title": "Number of days before the start from which sign-ups are closed.", "type": "integer" }, "sign_up_delete_hours_before": { "title": "Hours before the start until which a participant can cancel the sign-up.", "type": "integer" }, "contact_person": { "title": "CRM person who is the contact for the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "performing_person": { "title": "CRM person who leads the event, for example the trainer.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "copy_main_sign_ups_to_booking": { "title": "Sign-ups of the main event are copied to the generated bookings.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "create_ticket_on_sign_up": { "title": "A ticket is created for each sign-up.", "type": "boolean" }, "ticket_on_sign_up_person": { "title": "CRM person who is the owner of the tickets created on sign-up.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "mail_create_text": { "title": "Short text of the e-mail sent when the event is created.", "type": "string" }, "mail_create_long_text": { "title": "Long text of the e-mail sent when the event is created.", "type": "string" }, "mail_delete_text": { "title": "Short text of the e-mail sent when the event is deleted.", "type": "string" }, "mail_delete_long_text": { "title": "Long text of the e-mail sent when the event is deleted.", "type": "string" }, "send_mail_on_confirm": { "title": "Send an e-mail when a sign-up is confirmed.", "type": "boolean" }, "mail_sign_up_confirm_text": { "title": "Short text of the e-mail sent when a sign-up is confirmed.", "type": "string" }, "mail_sign_up_confirm_long_text": { "title": "Long text of the e-mail sent when a sign-up is confirmed.", "type": "string" }, "send_mail_on_delete": { "title": "Send an e-mail when a sign-up is cancelled.", "type": "boolean" }, "mail_sign_up_delete_text": { "title": "Short text of the e-mail sent when a sign-up is cancelled.", "type": "string" }, "mail_sign_up_delete_long_text": { "title": "Long text of the e-mail sent when a sign-up is cancelled.", "type": "string" }, "require_price_for_confirm": { "title": "A price must be set before a sign-up can be confirmed.", "type": "boolean" }, "variants": { "title": "Variants of the event, for example different prices or dates.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventVariant" } }, "tax": { "title": "Tax rate used for the prices of the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "billing_payment_profile": { "title": "Payment profile used for billing the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } ] }, "media_questionnaire": { "title": "Questionnaire of the event in the media module.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaire7" } ] }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "chatroom": { "title": "Chat room of the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/Chatroom10" } ] }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_rank_by": { "title": "Wertung nach Netto- (NET) oder Bruttozeit (GROSS).", "type": "string" }, "timing_min_lap_seconds": { "title": "Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.", "type": "integer" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent15": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent16": { "type": "object" }, "BaseEvent17": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent18": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the event.", "description": "Used in links and QR codes instead of the ID.", "type": "string" }, "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_keywords": { "title": "Keywords shown in the public event listing.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "age_group": { "title": "Age group the event is intended for, for example children or adults.", "type": "string" }, "min_age": { "title": "Minimum age in years of participants.", "type": "integer" }, "max_age": { "title": "Maximum age in years of participants.", "type": "integer" }, "min_age_months": { "title": "Minimum age in months of participants, for events for infants.", "type": "integer" }, "max_age_months": { "title": "Maximum age in months of participants, for events for infants.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level of participants.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level of participants.", "type": "integer" }, "age_tolerance": { "title": "Years by which participants may be outside the age range and still sign up.", "type": "integer" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "event_people_recovered_vaccinated_limit": { "title": "Maximum number of recovered or vaccinated participants.", "type": "integer" }, "event_people_not_recovered_vaccinated_limit": { "title": "Maximum number of participants who are neither recovered nor vaccinated.", "type": "integer" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "sign_up_limit_days_before": { "title": "Number of days before the start until which sign-ups are possible.", "type": "integer" }, "sign_up_limit_stop_days_before": { "title": "Number of days before the start from which sign-ups are closed.", "type": "integer" }, "sign_up_delete_hours_before": { "title": "Hours before the start until which a participant can cancel the sign-up.", "type": "integer" }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "copy_main_sign_ups_to_booking": { "title": "Sign-ups of the main event are copied to the generated bookings.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_rank_by": { "title": "Wertung nach Netto- (NET) oder Bruttozeit (GROSS).", "type": "string" }, "timing_min_lap_seconds": { "title": "Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.", "type": "integer" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent2": { "properties": { "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "billing_payment_profile": { "title": "Payment profile used for billing the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingPaymentProfile17" } ] }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "utags": { "title": "Unified tags of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag4" } }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent20": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the event.", "description": "Used in links and QR codes instead of the ID.", "type": "string" }, "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_keywords": { "title": "Keywords shown in the public event listing.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "age_group": { "title": "Age group the event is intended for, for example children or adults.", "type": "string" }, "min_age": { "title": "Minimum age in years of participants.", "type": "integer" }, "max_age": { "title": "Maximum age in years of participants.", "type": "integer" }, "min_age_months": { "title": "Minimum age in months of participants, for events for infants.", "type": "integer" }, "max_age_months": { "title": "Maximum age in months of participants, for events for infants.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level of participants.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level of participants.", "type": "integer" }, "age_tolerance": { "title": "Years by which participants may be outside the age range and still sign up.", "type": "integer" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "event_people_recovered_vaccinated_limit": { "title": "Maximum number of recovered or vaccinated participants.", "type": "integer" }, "event_people_not_recovered_vaccinated_limit": { "title": "Maximum number of participants who are neither recovered nor vaccinated.", "type": "integer" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "sign_up_limit_days_before": { "title": "Number of days before the start until which sign-ups are possible.", "type": "integer" }, "sign_up_limit_stop_days_before": { "title": "Number of days before the start from which sign-ups are closed.", "type": "integer" }, "sign_up_delete_hours_before": { "title": "Hours before the start until which a participant can cancel the sign-up.", "type": "integer" }, "performing_person": { "title": "CRM person who leads the event, for example the trainer.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson59" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson59" } ] }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "copy_main_sign_ups_to_booking": { "title": "Sign-ups of the main event are copied to the generated bookings.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_rank_by": { "title": "Wertung nach Netto- (NET) oder Bruttozeit (GROSS).", "type": "string" }, "timing_min_lap_seconds": { "title": "Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.", "type": "integer" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson59" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson59" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson59" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent21": { "properties": { "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" } }, "type": "object" }, "BaseEvent22": { "properties": { "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent24": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the event.", "description": "Used in links and QR codes instead of the ID.", "type": "string" }, "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_keywords": { "title": "Keywords shown in the public event listing.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "age_group": { "title": "Age group the event is intended for, for example children or adults.", "type": "string" }, "min_age": { "title": "Minimum age in years of participants.", "type": "integer" }, "max_age": { "title": "Maximum age in years of participants.", "type": "integer" }, "min_age_months": { "title": "Minimum age in months of participants, for events for infants.", "type": "integer" }, "max_age_months": { "title": "Maximum age in months of participants, for events for infants.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level of participants.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level of participants.", "type": "integer" }, "age_tolerance": { "title": "Years by which participants may be outside the age range and still sign up.", "type": "integer" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "event_people_recovered_vaccinated_limit": { "title": "Maximum number of recovered or vaccinated participants.", "type": "integer" }, "event_people_not_recovered_vaccinated_limit": { "title": "Maximum number of participants who are neither recovered nor vaccinated.", "type": "integer" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "sign_up_limit_days_before": { "title": "Number of days before the start until which sign-ups are possible.", "type": "integer" }, "sign_up_limit_stop_days_before": { "title": "Number of days before the start from which sign-ups are closed.", "type": "integer" }, "sign_up_delete_hours_before": { "title": "Hours before the start until which a participant can cancel the sign-up.", "type": "integer" }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "copy_main_sign_ups_to_booking": { "title": "Sign-ups of the main event are copied to the generated bookings.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "media_questionnaire": { "title": "Questionnaire of the event in the media module.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaire2" } ] }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_rank_by": { "title": "Wertung nach Netto- (NET) oder Bruttozeit (GROSS).", "type": "string" }, "timing_min_lap_seconds": { "title": "Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.", "type": "integer" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage9" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory27" } }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent25": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the event.", "description": "Used in links and QR codes instead of the ID.", "type": "string" }, "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_keywords": { "title": "Keywords shown in the public event listing.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "age_group": { "title": "Age group the event is intended for, for example children or adults.", "type": "string" }, "min_age": { "title": "Minimum age in years of participants.", "type": "integer" }, "max_age": { "title": "Maximum age in years of participants.", "type": "integer" }, "min_age_months": { "title": "Minimum age in months of participants, for events for infants.", "type": "integer" }, "max_age_months": { "title": "Maximum age in months of participants, for events for infants.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level of participants.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level of participants.", "type": "integer" }, "age_tolerance": { "title": "Years by which participants may be outside the age range and still sign up.", "type": "integer" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "event_people_recovered_vaccinated_limit": { "title": "Maximum number of recovered or vaccinated participants.", "type": "integer" }, "event_people_not_recovered_vaccinated_limit": { "title": "Maximum number of participants who are neither recovered nor vaccinated.", "type": "integer" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "sign_up_limit_days_before": { "title": "Number of days before the start until which sign-ups are possible.", "type": "integer" }, "sign_up_limit_stop_days_before": { "title": "Number of days before the start from which sign-ups are closed.", "type": "integer" }, "sign_up_delete_hours_before": { "title": "Hours before the start until which a participant can cancel the sign-up.", "type": "integer" }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "copy_main_sign_ups_to_booking": { "title": "Sign-ups of the main event are copied to the generated bookings.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_rank_by": { "title": "Wertung nach Netto- (NET) oder Bruttozeit (GROSS).", "type": "string" }, "timing_min_lap_seconds": { "title": "Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.", "type": "integer" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent26": { "properties": { "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "billing_payment_profile": { "title": "Payment profile used for billing the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingPaymentProfile19" } ] }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "utags": { "title": "Unified tags of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag9" } }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent28": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the event.", "description": "Used in links and QR codes instead of the ID.", "type": "string" }, "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_keywords": { "title": "Keywords shown in the public event listing.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "age_group": { "title": "Age group the event is intended for, for example children or adults.", "type": "string" }, "min_age": { "title": "Minimum age in years of participants.", "type": "integer" }, "max_age": { "title": "Maximum age in years of participants.", "type": "integer" }, "min_age_months": { "title": "Minimum age in months of participants, for events for infants.", "type": "integer" }, "max_age_months": { "title": "Maximum age in months of participants, for events for infants.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level of participants.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level of participants.", "type": "integer" }, "age_tolerance": { "title": "Years by which participants may be outside the age range and still sign up.", "type": "integer" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "event_people_recovered_vaccinated_limit": { "title": "Maximum number of recovered or vaccinated participants.", "type": "integer" }, "event_people_not_recovered_vaccinated_limit": { "title": "Maximum number of participants who are neither recovered nor vaccinated.", "type": "integer" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "sign_up_limit_days_before": { "title": "Number of days before the start until which sign-ups are possible.", "type": "integer" }, "sign_up_limit_stop_days_before": { "title": "Number of days before the start from which sign-ups are closed.", "type": "integer" }, "sign_up_delete_hours_before": { "title": "Hours before the start until which a participant can cancel the sign-up.", "type": "integer" }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "copy_main_sign_ups_to_booking": { "title": "Sign-ups of the main event are copied to the generated bookings.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_rank_by": { "title": "Wertung nach Netto- (NET) oder Bruttozeit (GROSS).", "type": "string" }, "timing_min_lap_seconds": { "title": "Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.", "type": "integer" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage11" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent3": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable9" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable9" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation8" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the event.", "description": "Used in links and QR codes instead of the ID.", "type": "string" }, "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_keywords": { "title": "Keywords shown in the public event listing.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "age_group": { "title": "Age group the event is intended for, for example children or adults.", "type": "string" }, "min_age": { "title": "Minimum age in years of participants.", "type": "integer" }, "max_age": { "title": "Maximum age in years of participants.", "type": "integer" }, "min_age_months": { "title": "Minimum age in months of participants, for events for infants.", "type": "integer" }, "max_age_months": { "title": "Maximum age in months of participants, for events for infants.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level of participants.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level of participants.", "type": "integer" }, "age_tolerance": { "title": "Years by which participants may be outside the age range and still sign up.", "type": "integer" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "event_people_recovered_vaccinated_limit": { "title": "Maximum number of recovered or vaccinated participants.", "type": "integer" }, "event_people_not_recovered_vaccinated_limit": { "title": "Maximum number of participants who are neither recovered nor vaccinated.", "type": "integer" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "sign_up_limit_days_before": { "title": "Number of days before the start until which sign-ups are possible.", "type": "integer" }, "sign_up_limit_stop_days_before": { "title": "Number of days before the start from which sign-ups are closed.", "type": "integer" }, "sign_up_delete_hours_before": { "title": "Hours before the start until which a participant can cancel the sign-up.", "type": "integer" }, "performing_person": { "title": "CRM person who leads the event, for example the trainer.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson49" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson49" } ] }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "copy_main_sign_ups_to_booking": { "title": "Sign-ups of the main event are copied to the generated bookings.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "sign_up_ui_more_information_hint": { "title": "Hint text shown in the sign-up form for more information.", "type": "string" }, "sign_up_ui_legal_hint": { "title": "Legal hint shown in the sign-up form.", "type": "string" }, "sign_up_ui_disclaimer_checkbox": { "title": "Text of the disclaimer checkbox in the sign-up form.", "type": "string" }, "sign_up_ui_privacy_checkbox": { "title": "Text of the privacy checkbox in the sign-up form.", "type": "string" }, "sign_up_ui_cancellation_checkbox": { "title": "Text of the cancellation checkbox in the sign-up form.", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_rank_by": { "title": "Wertung nach Netto- (NET) oder Bruttozeit (GROSS).", "type": "string" }, "timing_min_lap_seconds": { "title": "Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.", "type": "integer" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson49" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson49" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson49" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true }, "unified_tag_ids": { "title": "IDs of the unified tags.", "type": "object", "additionalProperties": true }, "unified_tag_names": { "title": "Names of the unified tags.", "type": "object", "additionalProperties": true }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent7": { "properties": { "ticketSeatingPlanId": { "title": "Id of the seating plan, also for the public and the customer serialization.", "type": "integer" }, "bib_numbers_enabled": { "type": "boolean" }, "timing_enabled": { "type": "boolean" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable3" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable3" }, "id": { "title": "Primary key of the event.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the event.", "description": "Used in links and QR codes instead of the ID.", "type": "string" }, "moments_mode": { "title": "Controls the event moments (digital guestbook) feature:\nDISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens,\nALL = additionally open via the anonymous event moments token", "type": "string" }, "moments_design": { "title": "Visual theme of the moments (digital guestbook) pages and exports.", "type": "string" }, "public_keywords": { "title": "Keywords shown in the public event listing.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown in the public event listing.", "type": "string" }, "event_type": { "title": "Type of the event, for example course, trip or tournament.", "type": "string" }, "age_group": { "title": "Age group the event is intended for, for example children or adults.", "type": "string" }, "min_age": { "title": "Minimum age in years of participants.", "type": "integer" }, "max_age": { "title": "Maximum age in years of participants.", "type": "integer" }, "min_age_months": { "title": "Minimum age in months of participants, for events for infants.", "type": "integer" }, "max_age_months": { "title": "Maximum age in months of participants, for events for infants.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level of participants.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level of participants.", "type": "integer" }, "age_tolerance": { "title": "Years by which participants may be outside the age range and still sign up.", "type": "integer" }, "event_people_limit": { "title": "maximum number of people that can attend the event", "type": "integer" }, "event_people_min_limit": { "title": "minimum number of people that must attend the event", "type": "integer" }, "hide_event_people_limit": { "title": "a setting to hide the event people limit in the frontend ui", "type": "boolean" }, "event_people_recovered_vaccinated_limit": { "title": "Maximum number of recovered or vaccinated participants.", "type": "integer" }, "event_people_not_recovered_vaccinated_limit": { "title": "Maximum number of participants who are neither recovered nor vaccinated.", "type": "integer" }, "has_wait_list": { "title": "The event has a waiting list once it is full.", "type": "boolean" }, "wait_list_confirmation_required": { "title": "Participants from the waiting list must confirm their place.", "type": "boolean" }, "trial_enabled": { "title": "Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in,\nthe rule comes from trialPolicy, the event's category or the default rule.", "type": "boolean" }, "can_sign_up_for_main_event": { "title": "Participants may sign up for the main event.", "type": "boolean" }, "only_sign_up_for_main_event": { "title": "Participants may only sign up for the main event, not for sub-events.", "type": "boolean" }, "sign_up_limit_days_before": { "title": "Number of days before the start until which sign-ups are possible.", "type": "integer" }, "sign_up_limit_stop_days_before": { "title": "Number of days before the start from which sign-ups are closed.", "type": "integer" }, "sign_up_delete_hours_before": { "title": "Hours before the start until which a participant can cancel the sign-up.", "type": "integer" }, "start_time": { "title": "Start of the event.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the event.", "type": "string", "format": "date-time" }, "require_address": { "title": "Participants must enter an address when signing up.", "type": "boolean" }, "require_contact": { "title": "Participants must enter contact details when signing up.", "type": "boolean" }, "require_billing": { "title": "Participants must enter billing details when signing up.", "type": "boolean" }, "allow_direct_billing": { "type": "boolean" }, "require_direct_billing": { "type": "boolean" }, "allow_budget_sign_up": { "type": "boolean" }, "require_age": { "title": "Participants must enter their age when signing up.", "type": "boolean" }, "require_grade_level": { "title": "Participants must enter their school grade level when signing up.", "type": "boolean" }, "require_free_note_field_ids": { "title": "IDs of the free note fields that participants must fill in.", "type": "string" }, "generate_new_bookings": { "title": "Bookings are generated automatically for the event schedule.", "type": "boolean" }, "generate_new_bookings_v2": { "title": "Bookings are generated with the second version of the schedule generator.", "type": "boolean" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "copy_main_sign_ups_to_booking": { "title": "Sign-ups of the main event are copied to the generated bookings.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "bitmask_days_of_week": { "title": "This is a bitmask value of the days of the week the event occurs on", "type": "integer" }, "bitmask_hours_start": { "title": "This is a bitmask value of the hours an event starts on", "type": "integer" }, "summarized_date_times": { "title": "This is a string with the days and hours an event starts on", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text shown in the customer app on the event detail page.", "type": "string" }, "customer_badge": { "title": "Badge text shown on the event in the customer app.", "type": "string" }, "bib_number_mode": { "title": "Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH.", "description": "Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).", "type": "string" }, "timing_gun_start": { "title": "Startschuss; ohne Wert gilt startTime.", "type": "string", "format": "date-time" }, "timing_rank_by": { "title": "Wertung nach Netto- (NET) oder Bruttozeit (GROSS).", "type": "string" }, "timing_min_lap_seconds": { "title": "Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.", "type": "integer" }, "timing_public_live": { "title": "Live timing results are public.", "type": "boolean" }, "timing_gps_tracking": { "title": "GPS tracking of participants is enabled for timing.", "type": "boolean" }, "timing_self_check_in": { "title": "Participants can check in themselves for timing.", "type": "boolean" }, "scoreboard_enabled": { "title": "Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind\nEventScoreboardActivity, der Spielstand wird daraus berechnet.", "type": "boolean" }, "scoreboard_sport": { "title": "Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.", "type": "string" }, "scoreboard_home_name": { "title": "Name of the home team on the scoreboard.", "type": "string" }, "scoreboard_away_name": { "title": "Name of the away team on the scoreboard.", "type": "string" }, "ticket_sales_enabled": { "title": "Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit\nKontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code f\u00fcr den Check-in.", "description": "Greift nur mit der Einstellung event_ticket_sales_enabled.", "type": "boolean" }, "ticket_max_per_order": { "title": "H\u00f6chstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.", "type": "integer" }, "ticket_personalized": { "title": "Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen\nalle Tickets einer Bestellung auf den Namen des K\u00e4ufers.", "type": "boolean" }, "ticket_seating": { "title": "Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des\nRaums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone)\nbeschr\u00e4nkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory16" } }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "BaseEvent9": { "type": "object" }, "BaseEventBibRange": { "properties": { "base_event_id": { "type": "integer" }, "id": { "title": "Primary key of the bib number range.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the bib number range.", "type": "string" }, "range_start": { "title": "First bib number of the range.", "type": "integer" }, "range_end": { "title": "Last bib number of the range.", "type": "integer" }, "prefix": { "title": "Fixed prefix for this range, wins over the global prefix mode.", "type": "string" }, "priority": { "title": "Priority of the range when several ranges match.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "BaseEventBibRange2": { "properties": { "name": { "title": "Name of the bib number range.", "type": "string" }, "range_start": { "title": "First bib number of the range.", "type": "integer" }, "range_end": { "title": "Last bib number of the range.", "type": "integer" }, "prefix": { "title": "Fixed prefix for this range, wins over the global prefix mode.", "type": "string" }, "priority": { "title": "Priority of the range when several ranges match.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseEventBookingSchedule": { "properties": { "id": { "title": "Primary key of the booking schedule.", "description": "Internal ID.", "type": "integer" }, "performing_person": { "title": "CRM person who leads the generated bookings.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the generated bookings.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "start_time": { "title": "Start of the schedule.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the schedule.", "type": "string", "format": "date-time" }, "generated_until": { "title": "Bookings are generated until this time.", "type": "string", "format": "date-time" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "recurrence_type": { "title": "L36: the recurrence rule - WEEKLY (default, every week on generateDayOfWeek),\nDAILY, WEEKLY_INTERVAL (every recurrenceInterval weeks), MONTHLY_DATE (day\nrecurrenceDayOfMonth), MONTHLY_WEEKDAY (the recurrenceWeekOfMonth-th\ngenerateDayOfWeek, -1 = last). Null behaves as WEEKLY.", "type": "string" }, "recurrence_interval": { "title": "Weeks between occurrences for WEEKLY_INTERVAL.", "type": "integer" }, "recurrence_day_of_month": { "title": "Day of the month (1-31) for MONTHLY_DATE; 31 means the last day of shorter months.", "type": "integer" }, "recurrence_week_of_month": { "title": "1-4 or -1 (last) for MONTHLY_WEEKDAY.", "type": "integer" }, "recurrence_count": { "title": "L37: the series ends after this many appointments (counted from the series start,\nignored days included); null = it ends with the end date only.", "type": "integer" }, "ignored_dates": { "title": "This property is used to store a string with ignored dates", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseEventBookingSchedule2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "note": { "title": "This property is used to store a note for an entity", "type": "string" } }, "type": "object" }, "BaseEventBookingSchedule3": { "properties": { "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent14" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "id": { "title": "Primary key of the booking schedule.", "description": "Internal ID.", "type": "integer" }, "performing_person": { "title": "CRM person who leads the generated bookings.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "secondary_performing_person": { "title": "Second CRM person who leads the generated bookings.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "start_time": { "title": "Start of the schedule.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the schedule.", "type": "string", "format": "date-time" }, "generated_until": { "title": "Bookings are generated until this time.", "type": "string", "format": "date-time" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "recurrence_type": { "title": "L36: the recurrence rule - WEEKLY (default, every week on generateDayOfWeek),\nDAILY, WEEKLY_INTERVAL (every recurrenceInterval weeks), MONTHLY_DATE (day\nrecurrenceDayOfMonth), MONTHLY_WEEKDAY (the recurrenceWeekOfMonth-th\ngenerateDayOfWeek, -1 = last). Null behaves as WEEKLY.", "type": "string" }, "recurrence_interval": { "title": "Weeks between occurrences for WEEKLY_INTERVAL.", "type": "integer" }, "recurrence_day_of_month": { "title": "Day of the month (1-31) for MONTHLY_DATE; 31 means the last day of shorter months.", "type": "integer" }, "recurrence_week_of_month": { "title": "1-4 or -1 (last) for MONTHLY_WEEKDAY.", "type": "integer" }, "recurrence_count": { "title": "L37: the series ends after this many appointments (counted from the series start,\nignored days included); null = it ends with the end date only.", "type": "integer" }, "ignored_dates": { "title": "This property is used to store a string with ignored dates", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseEventBookingSchedule4": { "properties": { "id": { "title": "Primary key of the booking schedule.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the schedule.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the schedule.", "type": "string", "format": "date-time" }, "generated_until": { "title": "Bookings are generated until this time.", "type": "string", "format": "date-time" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "recurrence_type": { "title": "L36: the recurrence rule - WEEKLY (default, every week on generateDayOfWeek),\nDAILY, WEEKLY_INTERVAL (every recurrenceInterval weeks), MONTHLY_DATE (day\nrecurrenceDayOfMonth), MONTHLY_WEEKDAY (the recurrenceWeekOfMonth-th\ngenerateDayOfWeek, -1 = last). Null behaves as WEEKLY.", "type": "string" }, "recurrence_interval": { "title": "Weeks between occurrences for WEEKLY_INTERVAL.", "type": "integer" }, "recurrence_day_of_month": { "title": "Day of the month (1-31) for MONTHLY_DATE; 31 means the last day of shorter months.", "type": "integer" }, "recurrence_week_of_month": { "title": "1-4 or -1 (last) for MONTHLY_WEEKDAY.", "type": "integer" }, "recurrence_count": { "title": "L37: the series ends after this many appointments (counted from the series start,\nignored days included); null = it ends with the end date only.", "type": "integer" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseEventBookingSchedule6": { "properties": { "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent18" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "id": { "title": "Primary key of the booking schedule.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the schedule.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the schedule.", "type": "string", "format": "date-time" }, "generated_until": { "title": "Bookings are generated until this time.", "type": "string", "format": "date-time" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "recurrence_type": { "title": "L36: the recurrence rule - WEEKLY (default, every week on generateDayOfWeek),\nDAILY, WEEKLY_INTERVAL (every recurrenceInterval weeks), MONTHLY_DATE (day\nrecurrenceDayOfMonth), MONTHLY_WEEKDAY (the recurrenceWeekOfMonth-th\ngenerateDayOfWeek, -1 = last). Null behaves as WEEKLY.", "type": "string" }, "recurrence_interval": { "title": "Weeks between occurrences for WEEKLY_INTERVAL.", "type": "integer" }, "recurrence_day_of_month": { "title": "Day of the month (1-31) for MONTHLY_DATE; 31 means the last day of shorter months.", "type": "integer" }, "recurrence_week_of_month": { "title": "1-4 or -1 (last) for MONTHLY_WEEKDAY.", "type": "integer" }, "recurrence_count": { "title": "L37: the series ends after this many appointments (counted from the series start,\nignored days included); null = it ends with the end date only.", "type": "integer" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseEventBookingSchedule7": { "properties": { "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent18" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseLocation": { "$ref": "#\/components\/schemas\/BaseLocation10" }, "id": { "title": "Primary key of the booking schedule.", "description": "Internal ID.", "type": "integer" }, "start_time": { "title": "Start of the schedule.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the schedule.", "type": "string", "format": "date-time" }, "generated_until": { "title": "Bookings are generated until this time.", "type": "string", "format": "date-time" }, "generate_ignore_sys_calendar": { "title": "Generated bookings ignore the holidays of the system calendar.", "type": "boolean" }, "generate_hour_start": { "title": "Start time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_hour_end": { "title": "End time of the day for generated bookings.", "type": "string", "format": "date-time" }, "generate_day_of_week": { "title": "Weekday for generated bookings.", "type": "integer" }, "recurrence_type": { "title": "L36: the recurrence rule - WEEKLY (default, every week on generateDayOfWeek),\nDAILY, WEEKLY_INTERVAL (every recurrenceInterval weeks), MONTHLY_DATE (day\nrecurrenceDayOfMonth), MONTHLY_WEEKDAY (the recurrenceWeekOfMonth-th\ngenerateDayOfWeek, -1 = last). Null behaves as WEEKLY.", "type": "string" }, "recurrence_interval": { "title": "Weeks between occurrences for WEEKLY_INTERVAL.", "type": "integer" }, "recurrence_day_of_month": { "title": "Day of the month (1-31) for MONTHLY_DATE; 31 means the last day of shorter months.", "type": "integer" }, "recurrence_week_of_month": { "title": "1-4 or -1 (last) for MONTHLY_WEEKDAY.", "type": "integer" }, "recurrence_count": { "title": "L37: the series ends after this many appointments (counted from the series start,\nignored days included); null = it ends with the end date only.", "type": "integer" }, "third_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fourth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "fifth_performing_person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseEventDataType": { "properties": { "id": { "title": "Identifier of the event data type.", "description": "For example course or trip.", "type": "string" }, "name": { "title": "Name of the event data type.", "type": "string" }, "menu_name": { "title": "Name of the menu entry for the event data type.", "type": "string" }, "show_admin_menu": { "title": "Show the event data type in the admin menu.", "type": "boolean" }, "show_customer_menu": { "title": "Show the event data type in the customer app menu.", "type": "boolean" }, "show_customer_description": { "title": "controls whether the customer event list shows the description below the headline", "type": "boolean" }, "customer_order_field_name": { "title": "Field the events are sorted by in the customer app.", "type": "string" }, "customer_order_field_sort": { "title": "Sort direction of the events in the customer app.", "type": "string" }, "show_customer_home_mode": { "title": "can be BOTH, ALL, OWN, NONE", "type": "string" }, "customer_home_show_more_button_text": { "title": "general text for show more button", "type": "string" }, "customer_home_own_more_button_text": { "title": "text for show more button of own events", "type": "string" }, "customer_home_headline_text": { "title": "text for headline of all events", "type": "string" }, "customer_home_own_headline_text": { "title": "text for headline of own events", "type": "string" }, "customer_home_only_same_day": { "title": "Show only events of the same day on the customer home screen.", "type": "boolean" }, "customer_home_order_field_name": { "title": "Field the events are sorted by on the customer home screen.", "type": "string" }, "customer_home_order_field_sort": { "title": "Sort direction of the events on the customer home screen.", "type": "string" }, "customer_detail_cta": { "title": "Call-to-action text on the event detail page in the customer app.", "type": "string" }, "customer_legal_hint": { "title": "Legal hint shown in the customer app.", "type": "string" }, "customer_legal_cancellation_policy": { "title": "Cancellation policy text shown in the customer app.", "type": "string" }, "customer_legal_privacy_policy": { "title": "Privacy policy text shown in the customer app.", "type": "string" }, "customer_legal_disclaimer": { "title": "Disclaimer text shown in the customer app.", "type": "string" }, "additional_filter_ids": { "title": "IDs of the additional filters for this event data type.", "type": "string" }, "allow_parallel_signup": { "title": "Participants may sign up for several events at the same time.", "type": "boolean" }, "has_defined_ui_settings": { "title": "Specific UI settings are defined for this event data type.", "type": "boolean" }, "trainer_can_add_participant": { "title": "Trainers can add participants.", "type": "boolean" }, "trainer_can_delete_participant": { "title": "Trainers can remove participants.", "type": "boolean" }, "trainer_can_delete_future_participant": { "title": "Trainers can remove participants from future bookings.", "type": "boolean" }, "trainer_can_cancel_booking": { "title": "Trainers can cancel a booking.", "type": "boolean" }, "trainer_can_send_message": { "title": "Trainers can send messages to participants.", "type": "boolean" }, "trainer_can_view_next_booking": { "title": "Trainers can see their next booking.", "type": "boolean" }, "trainer_can_create_chatroom": { "title": "Duerfen Trainer*innen fuer eine Veranstaltung dieser Art selbst einen\nChatroom anlegen?", "description": "Der Chat wird danach automatisch mit den Anmeldungen synchronisiert -\nsiehe chatroomWeeksBeforeEvent \/ chatroomWeeksAfterEvent und die\nbeiden Rauswurf-Fristen.", "type": "boolean" }, "enable_bib_numbers": { "title": "Events dieses Typs koennen Startnummern vergeben\n(siehe docs\/event\/STARTNUMMERN_ZEITMESSUNG.md).", "type": "boolean" }, "enable_timing": { "title": "Events dieses Typs haben Zeitmessung, Live-Tracking und Ergebnislisten.", "type": "boolean" }, "trainer_can_edit_scoreboard": { "title": "Duerfen Trainer*innen bei Events dieses Typs mit Scoreboard den Spielstand\nund den Spielbericht (Tore, Karten, Strafen, ...) in der Kunden-App eintragen?", "type": "boolean" }, "trainer_can_claim_substitution": { "title": "Duerfen Trainer*innen offene Termine dieses Typs, fuer die eine Vertretung gesucht wird,\nin der Kunden-App selbst uebernehmen? Greift nur, wenn event_substitution_enabled an ist.", "type": "boolean" }, "trainer_can_release_for_substitution": { "title": "Duerfen Trainer*innen bei Terminen dieses Typs selbst eine Vertretung suchen (\"ich kann\nnicht\"): sie werden ausgetragen, der Termin wird anderen Trainer*innen angeboten.", "type": "boolean" }, "kiosk_visible": { "title": "Erscheinen Termine dieses Typs in der Kiosk-App fuer Mitglieder?\nGreift nur, wenn kiosk_enabled an ist.", "type": "boolean" }, "kiosk_self_check_in_allowed": { "title": "Duerfen sich Mitglieder am Kiosk selbst fuer Termine dieses Typs\neinchecken? Greift nur, wenn kiosk_self_check_in_enabled an ist.", "type": "boolean" }, "kiosk_follow_up_allowed": { "title": "Duerfen sich Mitglieder am Kiosk fuer den Folgetermin eines Kurses\ndieses Typs anmelden? Greift nur, wenn kiosk_follow_up_signup_enabled an ist.", "type": "boolean" }, "chatroom_weeks_before_event": { "title": "Wie viele Wochen vor Beginn des Event-Zeitraums der Chatroom bereits\nexistiert.", "description": "Leer heisst: keine untere Grenze, der Chatroom kann jederzeit vorab\nangelegt werden.", "type": "integer" }, "chatroom_weeks_after_event": { "title": "Wie viele Wochen nach Ende des Event-Zeitraums der Chatroom noch\nexistiert. Danach wird er als geloescht markiert.", "description": "Leer heisst: der Chatroom bleibt unbefristet bestehen.", "type": "integer" }, "chatroom_remove_days_after_continuous": { "title": "Frist in Tagen, nach der eine Person mit fortlaufender Teilnahme\n(Anmeldung am Haupt-Event) aus dem Chat entfernt wird - gerechnet ab\ndem Ende ihrer Teilnahme.", "description": "Leer heisst: kein automatischer Rauswurf.", "type": "integer" }, "chatroom_remove_days_after_single": { "title": "Frist in Tagen, nach der eine Person mit einmaliger Teilnahme\n(Anmeldung an einem einzelnen Termin) aus dem Chat entfernt wird -\ngerechnet ab dem Ende dieses Termins.", "description": "Leer heisst: kein automatischer Rauswurf.", "type": "integer" }, "chatroom_participants_can_write": { "title": "Bekommen Teilnehmende im Event-Chat automatisch Schreibrechte?", "description": "Gilt nur beim Anlegen bzw. Wiederaufnehmen durch die Synchronisation -\nwas Trainer*innen danach von Hand je Person umstellen, bleibt bestehen.\nTrainer*innen selbst duerfen unabhaengig davon immer schreiben.", "type": "boolean" }, "chatroom_chatbot_profile": { "title": "KI-Assistent, den der Event-Sync beim Anlegen des Event-Chats\nhinzufuegt. Leer heisst: kein Bot im Event-Chat. Der Modus des Profils\nmuss zur Vertrauensstufe des Raums passen (member oder public).", "oneOf": [ { "$ref": "#\/components\/schemas\/ChatbotProfile3" } ] }, "trainer_order_field_name": { "title": "Sortierung der Teilnehmerliste, die Trainer*innen zu sehen bekommen.", "description": "Ohne Angabe bleibt es bei der Reihenfolge der Anmeldung (id), alternativ\nwird die Liste alphabetisch nach Vor- oder Nachname sortiert.", "type": "string" }, "default_expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr Rechnungen aus Veranstaltungen dieser Art.", "description": "Beim gemeinn\u00fctzigen Verein h\u00e4ngt an der Veranstaltungsart, in welche\nSph\u00e4re die Teilnehmergeb\u00fchren geh\u00f6ren: ein satzungsgem\u00e4\u00dfer Kurs ist\nZweckbetrieb und damit k\u00f6rperschaft- und gewerbesteuerfrei, ein Angebot\nin Konkurrenz zu gewerblichen Anbietern ein steuerpflichtiger\nwirtschaftlicher Gesch\u00e4ftsbetrieb. Das l\u00e4sst sich nur je Art\nentscheiden, nicht global.\n\nBleibt das Feld leer, greift wie bisher die Vorbelegung der Buchungsart.", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "BaseEventInvitation": { "properties": { "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent15" }, "id": { "title": "Primary key of the invitation.", "description": "Internal ID.", "type": "integer" }, "read": { "title": "The invitation was read.", "type": "boolean" }, "token": { "title": "Public token of the invitation.", "description": "Used in the invitation link instead of the ID.", "type": "string" }, "first_name": { "title": "First name of the invited person.", "type": "string" }, "last_name": { "title": "Last name of the invited person.", "type": "string" }, "gender": { "title": "Gender of the invited person.", "type": "string" }, "birthday": { "title": "Birthday of the invited person.", "type": "string", "format": "date-time" }, "message": { "title": "Message sent with the invitation.", "type": "string" }, "reply_message": { "title": "Reply message of the invited person.", "type": "string" } }, "type": "object" }, "BaseEventInvitation2": { "properties": { "id": { "title": "Primary key of the invitation.", "description": "Internal ID.", "type": "integer" }, "read": { "title": "The invitation was read.", "type": "boolean" }, "message": { "title": "Message sent with the invitation.", "type": "string" }, "reply_message": { "title": "Reply message of the invited person.", "type": "string" }, "company": { "title": "Company the entity belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany27" } ] }, "person": { "title": "Person the entity belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson53" } ] }, "base_event": { "title": "Event the entity belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent16" } ] } }, "type": "object" }, "BaseEventInvitation3": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany28" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson54" }, "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent17" }, "id": { "title": "Primary key of the invitation.", "description": "Internal ID.", "type": "integer" }, "read": { "title": "The invitation was read.", "type": "boolean" }, "token": { "title": "Public token of the invitation.", "description": "Used in the invitation link instead of the ID.", "type": "string" }, "first_name": { "title": "First name of the invited person.", "type": "string" }, "last_name": { "title": "Last name of the invited person.", "type": "string" }, "gender": { "title": "Gender of the invited person.", "type": "string" }, "birthday": { "title": "Birthday of the invited person.", "type": "string", "format": "date-time" }, "message": { "title": "Message sent with the invitation.", "type": "string" }, "reply_message": { "title": "Reply message of the invited person.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "BaseEventInvitation4": { "type": "object" }, "BaseEventInvitation5": { "properties": { "id": { "title": "Primary key of the invitation.", "description": "Internal ID.", "type": "integer" }, "read": { "title": "The invitation was read.", "type": "boolean" }, "message": { "title": "Message sent with the invitation.", "type": "string" }, "reply_message": { "title": "Reply message of the invited person.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "BaseEventSignUp": { "properties": { "id": { "title": "Primary key of the sign-up.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "waiting": { "title": "The sign-up is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The sign-up is confirmed.", "type": "boolean" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "wait_list_confirmation_sent_at": { "type": "string", "format": "date-time" }, "wait_list_confirmation_deadline": { "type": "string", "format": "date-time" }, "wait_list_confirmed_at": { "type": "string", "format": "date-time" }, "wait_list_pending_confirmation": { "type": "boolean" }, "wait_list_sort_order": { "type": "integer" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Guardian allows photos of the participant.", "type": "boolean" }, "allow_child_alone": { "title": "Participant may leave alone after the event.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the participant.", "type": "string" }, "needs_support": { "title": "Participant needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the participant needs.", "type": "string" }, "financial_support": { "title": "Participant receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support, for example a voucher.", "type": "string" }, "municipal_support": { "title": "Participant receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "self_check_in": { "title": "Participant checked in with the self-service check-in.", "type": "boolean" }, "self_check_out": { "title": "Participant checked out with the self-service check-out.", "type": "boolean" }, "self_check_in_date": { "title": "Time of the self-service check-in.", "type": "string", "format": "date-time" }, "self_check_out_date": { "title": "Time of the self-service check-out.", "type": "string", "format": "date-time" }, "reminded_of_absence": { "title": "Time the guardian was reminded of an absence.", "type": "string", "format": "date-time" }, "trial": { "title": "Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of\nthe person's trial pass (eventAccessBudget with sourceType trial)", "type": "boolean" }, "trial_channel": { "title": "Who booked the trial date: app, trainer, office", "type": "string" }, "trial_session_number": { "title": "Number of this trial date within the pass (1 = first), for \"Schnuppern 2\/3\"", "type": "integer" }, "trial_session_max": { "title": "Trial dates of the pass, for \"Schnuppern 2\/3\"", "type": "integer" }, "confirmed_date": { "title": "Time the sign-up was confirmed.", "type": "string", "format": "date-time" }, "bib_number": { "title": "Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig.", "description": "Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.", "type": "integer" }, "bib_label": { "title": "Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "BaseEventSignUp10": { "properties": { "bib_range_id": { "type": "integer" }, "age_class": { "title": "Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.", "type": "string" }, "id": { "title": "Primary key of the sign-up.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "token": { "title": "Public token of the sign-up.", "description": "Used in links instead of the ID.", "type": "string" }, "moments_token": { "title": "Participant-bound moments token: allows this participant to use the event moments\n(digital guestbook) page; uploads via this token are linked to the participant.", "type": "string" }, "waiting": { "title": "The sign-up is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The sign-up is confirmed.", "type": "boolean" }, "external": { "title": "The sign-up was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "billed": { "title": "The sign-up was billed.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "wait_list_confirmation_token": { "type": "string" }, "wait_list_confirmation_sent_at": { "type": "string", "format": "date-time" }, "wait_list_confirmation_deadline": { "type": "string", "format": "date-time" }, "wait_list_confirmed_at": { "type": "string", "format": "date-time" }, "wait_list_pending_confirmation": { "type": "boolean" }, "wait_list_sort_order": { "type": "integer" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "trial": { "title": "Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of\nthe person's trial pass (eventAccessBudget with sourceType trial)", "type": "boolean" }, "trial_channel": { "title": "Who booked the trial date: app, trainer, office", "type": "string" }, "trial_session_number": { "title": "Number of this trial date within the pass (1 = first), for \"Schnuppern 2\/3\"", "type": "integer" }, "trial_session_max": { "title": "Trial dates of the pass, for \"Schnuppern 2\/3\"", "type": "integer" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "bib_number": { "title": "Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig.", "description": "Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.", "type": "integer" }, "bib_label": { "title": "Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.", "type": "string" }, "bib_number_assigned_at": { "title": "Time the bib number was assigned.", "type": "string", "format": "date-time" }, "chip_code": { "title": "Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.", "type": "string" }, "timing_tracking_consent": { "title": "Einwilligung in das GPS-Live-Tracking waehrend des Events.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "BaseEventSignUp11": { "properties": { "bib_range_id": { "type": "integer" }, "age_class": { "title": "Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.", "type": "string" }, "id": { "title": "Primary key of the sign-up.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "token": { "title": "Public token of the sign-up.", "description": "Used in links instead of the ID.", "type": "string" }, "moments_token": { "title": "Participant-bound moments token: allows this participant to use the event moments\n(digital guestbook) page; uploads via this token are linked to the participant.", "type": "string" }, "waiting": { "title": "The sign-up is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The sign-up is confirmed.", "type": "boolean" }, "external": { "title": "The sign-up was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "billed": { "title": "The sign-up was billed.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "wait_list_confirmation_token": { "type": "string" }, "wait_list_confirmation_sent_at": { "type": "string", "format": "date-time" }, "wait_list_confirmation_deadline": { "type": "string", "format": "date-time" }, "wait_list_confirmed_at": { "type": "string", "format": "date-time" }, "wait_list_pending_confirmation": { "type": "boolean" }, "wait_list_sort_order": { "type": "integer" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "trial": { "title": "Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of\nthe person's trial pass (eventAccessBudget with sourceType trial)", "type": "boolean" }, "trial_channel": { "title": "Who booked the trial date: app, trainer, office", "type": "string" }, "trial_session_number": { "title": "Number of this trial date within the pass (1 = first), for \"Schnuppern 2\/3\"", "type": "integer" }, "trial_session_max": { "title": "Trial dates of the pass, for \"Schnuppern 2\/3\"", "type": "integer" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "bib_number": { "title": "Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig.", "description": "Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.", "type": "integer" }, "bib_label": { "title": "Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.", "type": "string" }, "bib_number_assigned_at": { "title": "Time the bib number was assigned.", "type": "string", "format": "date-time" }, "chip_code": { "title": "Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.", "type": "string" }, "timing_tracking_consent": { "title": "Einwilligung in das GPS-Live-Tracking waehrend des Events.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "BaseEventSignUp17": { "properties": { "bib_range_id": { "type": "integer" }, "age_class": { "title": "Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.", "type": "string" }, "id": { "title": "Primary key of the sign-up.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "token": { "title": "Public token of the sign-up.", "description": "Used in links instead of the ID.", "type": "string" }, "moments_token": { "title": "Participant-bound moments token: allows this participant to use the event moments\n(digital guestbook) page; uploads via this token are linked to the participant.", "type": "string" }, "waiting": { "title": "The sign-up is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The sign-up is confirmed.", "type": "boolean" }, "external": { "title": "The sign-up was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "billed": { "title": "The sign-up was billed.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "wait_list_confirmation_token": { "type": "string" }, "wait_list_confirmation_sent_at": { "type": "string", "format": "date-time" }, "wait_list_confirmation_deadline": { "type": "string", "format": "date-time" }, "wait_list_confirmed_at": { "type": "string", "format": "date-time" }, "wait_list_pending_confirmation": { "type": "boolean" }, "wait_list_sort_order": { "type": "integer" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "trial": { "title": "Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of\nthe person's trial pass (eventAccessBudget with sourceType trial)", "type": "boolean" }, "trial_channel": { "title": "Who booked the trial date: app, trainer, office", "type": "string" }, "trial_session_number": { "title": "Number of this trial date within the pass (1 = first), for \"Schnuppern 2\/3\"", "type": "integer" }, "trial_session_max": { "title": "Trial dates of the pass, for \"Schnuppern 2\/3\"", "type": "integer" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "bib_number": { "title": "Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig.", "description": "Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.", "type": "integer" }, "bib_label": { "title": "Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.", "type": "string" }, "bib_number_assigned_at": { "title": "Time the bib number was assigned.", "type": "string", "format": "date-time" }, "chip_code": { "title": "Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.", "type": "string" }, "timing_tracking_consent": { "title": "Einwilligung in das GPS-Live-Tracking waehrend des Events.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "BaseEventSignUp18": { "properties": { "id": { "title": "Primary key of the sign-up.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "waiting": { "title": "The sign-up is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The sign-up is confirmed.", "type": "boolean" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "wait_list_confirmation_sent_at": { "type": "string", "format": "date-time" }, "wait_list_confirmation_deadline": { "type": "string", "format": "date-time" }, "wait_list_confirmed_at": { "type": "string", "format": "date-time" }, "wait_list_pending_confirmation": { "type": "boolean" }, "wait_list_sort_order": { "type": "integer" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Guardian allows photos of the participant.", "type": "boolean" }, "allow_child_alone": { "title": "Participant may leave alone after the event.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the participant.", "type": "string" }, "needs_support": { "title": "Participant needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the participant needs.", "type": "string" }, "financial_support": { "title": "Participant receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support, for example a voucher.", "type": "string" }, "municipal_support": { "title": "Participant receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "self_check_in": { "title": "Participant checked in with the self-service check-in.", "type": "boolean" }, "self_check_out": { "title": "Participant checked out with the self-service check-out.", "type": "boolean" }, "self_check_in_date": { "title": "Time of the self-service check-in.", "type": "string", "format": "date-time" }, "self_check_out_date": { "title": "Time of the self-service check-out.", "type": "string", "format": "date-time" }, "reminded_of_absence": { "title": "Time the guardian was reminded of an absence.", "type": "string", "format": "date-time" }, "trial": { "title": "Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of\nthe person's trial pass (eventAccessBudget with sourceType trial)", "type": "boolean" }, "trial_channel": { "title": "Who booked the trial date: app, trainer, office", "type": "string" }, "trial_session_number": { "title": "Number of this trial date within the pass (1 = first), for \"Schnuppern 2\/3\"", "type": "integer" }, "trial_session_max": { "title": "Trial dates of the pass, for \"Schnuppern 2\/3\"", "type": "integer" }, "confirmed_date": { "title": "Time the sign-up was confirmed.", "type": "string", "format": "date-time" }, "bib_number": { "title": "Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig.", "description": "Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.", "type": "integer" }, "bib_label": { "title": "Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.", "type": "string" } }, "type": "object" }, "BaseEventSignUp19": { "properties": { "bib_range_id": { "type": "integer" }, "age_class": { "title": "Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.", "type": "string" }, "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the sign-up.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "token": { "title": "Public token of the sign-up.", "description": "Used in links instead of the ID.", "type": "string" }, "moments_token": { "title": "Participant-bound moments token: allows this participant to use the event moments\n(digital guestbook) page; uploads via this token are linked to the participant.", "type": "string" }, "waiting": { "title": "The sign-up is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The sign-up is confirmed.", "type": "boolean" }, "external": { "title": "The sign-up was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "billed": { "title": "The sign-up was billed.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "wait_list_confirmation_token": { "type": "string" }, "wait_list_confirmation_sent_at": { "type": "string", "format": "date-time" }, "wait_list_confirmation_deadline": { "type": "string", "format": "date-time" }, "wait_list_confirmed_at": { "type": "string", "format": "date-time" }, "wait_list_pending_confirmation": { "type": "boolean" }, "wait_list_sort_order": { "type": "integer" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "trial": { "title": "Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of\nthe person's trial pass (eventAccessBudget with sourceType trial)", "type": "boolean" }, "trial_channel": { "title": "Who booked the trial date: app, trainer, office", "type": "string" }, "trial_session_number": { "title": "Number of this trial date within the pass (1 = first), for \"Schnuppern 2\/3\"", "type": "integer" }, "trial_session_max": { "title": "Trial dates of the pass, for \"Schnuppern 2\/3\"", "type": "integer" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "bib_number": { "title": "Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig.", "description": "Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.", "type": "integer" }, "bib_label": { "title": "Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.", "type": "string" }, "bib_number_assigned_at": { "title": "Time the bib number was assigned.", "type": "string", "format": "date-time" }, "chip_code": { "title": "Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.", "type": "string" }, "timing_tracking_consent": { "title": "Einwilligung in das GPS-Live-Tracking waehrend des Events.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "BaseEventSignUp20": { "properties": { "bib_range_id": { "type": "integer" }, "age_class": { "title": "Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.", "type": "string" }, "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the sign-up.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "token": { "title": "Public token of the sign-up.", "description": "Used in links instead of the ID.", "type": "string" }, "moments_token": { "title": "Participant-bound moments token: allows this participant to use the event moments\n(digital guestbook) page; uploads via this token are linked to the participant.", "type": "string" }, "waiting": { "title": "The sign-up is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The sign-up is confirmed.", "type": "boolean" }, "external": { "title": "The sign-up was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "billed": { "title": "The sign-up was billed.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "wait_list_confirmation_token": { "type": "string" }, "wait_list_confirmation_sent_at": { "type": "string", "format": "date-time" }, "wait_list_confirmation_deadline": { "type": "string", "format": "date-time" }, "wait_list_confirmed_at": { "type": "string", "format": "date-time" }, "wait_list_pending_confirmation": { "type": "boolean" }, "wait_list_sort_order": { "type": "integer" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "media_questionnaire_answer": { "title": "Answer to the questionnaire of the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer3" } ] }, "secondary_media_questionnaire_answer": { "title": "Answer of a further questionnaire sent to the signup (mass notification with questionnaire\ndraft) while mediaQuestionnaireAnswer already holds the answer to the sign-up form.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer3" } ] }, "trial": { "title": "Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of\nthe person's trial pass (eventAccessBudget with sourceType trial)", "type": "boolean" }, "trial_channel": { "title": "Who booked the trial date: app, trainer, office", "type": "string" }, "trial_session_number": { "title": "Number of this trial date within the pass (1 = first), for \"Schnuppern 2\/3\"", "type": "integer" }, "trial_session_max": { "title": "Trial dates of the pass, for \"Schnuppern 2\/3\"", "type": "integer" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "bib_number": { "title": "Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig.", "description": "Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.", "type": "integer" }, "bib_label": { "title": "Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.", "type": "string" }, "bib_number_assigned_at": { "title": "Time the bib number was assigned.", "type": "string", "format": "date-time" }, "chip_code": { "title": "Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.", "type": "string" }, "timing_tracking_consent": { "title": "Einwilligung in das GPS-Live-Tracking waehrend des Events.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "BaseEventSignUp21": { "properties": { "bib_range_id": { "type": "integer" }, "age_class": { "title": "Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.", "type": "string" }, "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the sign-up.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "token": { "title": "Public token of the sign-up.", "description": "Used in links instead of the ID.", "type": "string" }, "moments_token": { "title": "Participant-bound moments token: allows this participant to use the event moments\n(digital guestbook) page; uploads via this token are linked to the participant.", "type": "string" }, "waiting": { "title": "The sign-up is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The sign-up is confirmed.", "type": "boolean" }, "external": { "title": "The sign-up was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "billed": { "title": "The sign-up was billed.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "wait_list_confirmation_token": { "type": "string" }, "wait_list_confirmation_sent_at": { "type": "string", "format": "date-time" }, "wait_list_confirmation_deadline": { "type": "string", "format": "date-time" }, "wait_list_confirmed_at": { "type": "string", "format": "date-time" }, "wait_list_pending_confirmation": { "type": "boolean" }, "wait_list_sort_order": { "type": "integer" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "media_questionnaire_answer": { "title": "Answer to the questionnaire of the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer10" } ] }, "secondary_media_questionnaire_answer": { "title": "Answer of a further questionnaire sent to the signup (mass notification with questionnaire\ndraft) while mediaQuestionnaireAnswer already holds the answer to the sign-up form.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer10" } ] }, "trial": { "title": "Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of\nthe person's trial pass (eventAccessBudget with sourceType trial)", "type": "boolean" }, "trial_channel": { "title": "Who booked the trial date: app, trainer, office", "type": "string" }, "trial_session_number": { "title": "Number of this trial date within the pass (1 = first), for \"Schnuppern 2\/3\"", "type": "integer" }, "trial_session_max": { "title": "Trial dates of the pass, for \"Schnuppern 2\/3\"", "type": "integer" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "bib_number": { "title": "Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig.", "description": "Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.", "type": "integer" }, "bib_label": { "title": "Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.", "type": "string" }, "bib_number_assigned_at": { "title": "Time the bib number was assigned.", "type": "string", "format": "date-time" }, "chip_code": { "title": "Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.", "type": "string" }, "timing_tracking_consent": { "title": "Einwilligung in das GPS-Live-Tracking waehrend des Events.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "BaseEventSignUp23": { "properties": { "bib_range_id": { "type": "integer" }, "age_class": { "title": "Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.", "type": "string" }, "id": { "title": "Primary key of the sign-up.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "token": { "title": "Public token of the sign-up.", "description": "Used in links instead of the ID.", "type": "string" }, "moments_token": { "title": "Participant-bound moments token: allows this participant to use the event moments\n(digital guestbook) page; uploads via this token are linked to the participant.", "type": "string" }, "waiting": { "title": "The sign-up is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The sign-up is confirmed.", "type": "boolean" }, "external": { "title": "The sign-up was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "billed": { "title": "The sign-up was billed.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "wait_list_confirmation_token": { "type": "string" }, "wait_list_confirmation_sent_at": { "type": "string", "format": "date-time" }, "wait_list_confirmation_deadline": { "type": "string", "format": "date-time" }, "wait_list_confirmed_at": { "type": "string", "format": "date-time" }, "wait_list_pending_confirmation": { "type": "boolean" }, "wait_list_sort_order": { "type": "integer" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "trial": { "title": "Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of\nthe person's trial pass (eventAccessBudget with sourceType trial)", "type": "boolean" }, "trial_channel": { "title": "Who booked the trial date: app, trainer, office", "type": "string" }, "trial_session_number": { "title": "Number of this trial date within the pass (1 = first), for \"Schnuppern 2\/3\"", "type": "integer" }, "trial_session_max": { "title": "Trial dates of the pass, for \"Schnuppern 2\/3\"", "type": "integer" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "bib_number": { "title": "Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig.", "description": "Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.", "type": "integer" }, "bib_label": { "title": "Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.", "type": "string" }, "bib_number_assigned_at": { "title": "Time the bib number was assigned.", "type": "string", "format": "date-time" }, "chip_code": { "title": "Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.", "type": "string" }, "timing_tracking_consent": { "title": "Einwilligung in das GPS-Live-Tracking waehrend des Events.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" }, "note": { "title": "This property is used to store a note for an entity", "type": "string" } }, "type": "object" }, "BaseEventSignUp3": { "properties": { "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Guardian allows photos of the participant.", "type": "boolean" }, "allow_child_alone": { "title": "Participant may leave alone after the event.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the participant.", "type": "string" }, "needs_support": { "title": "Participant needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the participant needs.", "type": "string" }, "financial_support": { "title": "Participant receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support, for example a voucher.", "type": "string" }, "municipal_support": { "title": "Participant receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "confirmed_disclaimer": { "title": "Participant confirmed the disclaimer.", "type": "boolean" }, "confirmed_privacy": { "title": "Participant confirmed the privacy policy.", "type": "boolean" }, "confirmed_cancellation_policy": { "title": "Participant confirmed the cancellation policy.", "type": "boolean" }, "free_note_one": { "title": "Free note 1 entered on the sign-up.", "type": "string" }, "free_note_two": { "title": "Free note 2 entered on the sign-up.", "type": "string" }, "free_note_three": { "title": "Free note 3 entered on the sign-up.", "type": "string" }, "free_note_four": { "title": "Free note 4 entered on the sign-up.", "type": "string" }, "invoice_products": { "title": "Product items added to the invoice of the sign-up.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventSignUpProductItem" } }, "self_check_in": { "title": "Participant checked in with the self-service check-in.", "type": "boolean" }, "self_check_out": { "title": "Participant checked out with the self-service check-out.", "type": "boolean" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "base_event": { "title": "Event the entity belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent21" } ] }, "base_booking": { "title": "Booking the entity belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking21" } ] } }, "type": "object" }, "BaseEventSignUp4": { "properties": { "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Guardian allows photos of the participant.", "type": "boolean" }, "allow_child_alone": { "title": "Participant may leave alone after the event.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the participant.", "type": "string" }, "needs_support": { "title": "Participant needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the participant needs.", "type": "string" }, "financial_support": { "title": "Participant receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support, for example a voucher.", "type": "string" }, "municipal_support": { "title": "Participant receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "confirmed_disclaimer": { "title": "Participant confirmed the disclaimer.", "type": "boolean" }, "confirmed_privacy": { "title": "Participant confirmed the privacy policy.", "type": "boolean" }, "confirmed_cancellation_policy": { "title": "Participant confirmed the cancellation policy.", "type": "boolean" }, "free_note_one": { "title": "Free note 1 entered on the sign-up.", "type": "string" }, "free_note_two": { "title": "Free note 2 entered on the sign-up.", "type": "string" }, "free_note_three": { "title": "Free note 3 entered on the sign-up.", "type": "string" }, "free_note_four": { "title": "Free note 4 entered on the sign-up.", "type": "string" }, "invoice_products": { "title": "Product items added to the invoice of the sign-up.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventSignUpProductItem2" } }, "self_check_in": { "title": "Participant checked in with the self-service check-in.", "type": "boolean" }, "self_check_out": { "title": "Participant checked out with the self-service check-out.", "type": "boolean" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "base_event": { "title": "Event the entity belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent22" } ] }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "base_booking": { "title": "Booking the entity belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking22" } ] } }, "type": "object" }, "BaseEventSignUp7": { "properties": { "bib_range_id": { "type": "integer" }, "ticketSeatLabel": { "title": "Label of the booked seat (\"row-number\"), for tickets, check-in and the ticket overview.", "type": "string" }, "age_class": { "title": "Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.", "type": "string" }, "id": { "title": "Primary key of the sign-up.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "token": { "title": "Public token of the sign-up.", "description": "Used in links instead of the ID.", "type": "string" }, "moments_token": { "title": "Participant-bound moments token: allows this participant to use the event moments\n(digital guestbook) page; uploads via this token are linked to the participant.", "type": "string" }, "waiting": { "title": "The sign-up is on the waiting list.", "type": "boolean" }, "confirmed": { "title": "The sign-up is confirmed.", "type": "boolean" }, "age_status": { "title": "Age status of a course sign-up against the age limits of the course (AgeLimits::STATUS_*),\nkept by AgeCheckService; null = not checked (date and trial sign-ups, courses without limits,\nfeature off). Only for the office.", "type": "string" }, "age_status_months": { "title": "Months beyond the nearer age limit at the last check (positive = older, negative = younger)", "type": "integer" }, "age_status_changed_at": { "title": "Time the age status of the participant last changed.", "type": "string", "format": "date-time" }, "age_notified_at": { "title": "When the office was told about the current age status (digest)", "type": "string", "format": "date-time" }, "external": { "title": "The sign-up was made by an external party.", "type": "boolean" }, "deletion_reason": { "title": "Reason the sign-up was cancelled.", "type": "string" }, "billed": { "title": "The sign-up was billed.", "type": "boolean" }, "direct_billing": { "type": "boolean" }, "direct_billing_check_date": { "type": "string", "format": "date-time" }, "direct_billing_token": { "type": "string" }, "wait_list_confirmation_token": { "type": "string" }, "wait_list_confirmation_sent_at": { "type": "string", "format": "date-time" }, "wait_list_confirmation_deadline": { "type": "string", "format": "date-time" }, "wait_list_confirmed_at": { "type": "string", "format": "date-time" }, "wait_list_pending_confirmation": { "type": "boolean" }, "wait_list_sort_order": { "type": "integer" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Guardian allows photos of the participant.", "type": "boolean" }, "allow_child_alone": { "title": "Participant may leave alone after the event.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the participant.", "type": "string" }, "needs_support": { "title": "Participant needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the participant needs.", "type": "string" }, "financial_support": { "title": "Participant receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support, for example a voucher.", "type": "string" }, "municipal_support": { "title": "Participant receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "confirmed_disclaimer": { "title": "Participant confirmed the disclaimer.", "type": "boolean" }, "confirmed_privacy": { "title": "Participant confirmed the privacy policy.", "type": "boolean" }, "confirmed_cancellation_policy": { "title": "Participant confirmed the cancellation policy.", "type": "boolean" }, "free_note_one": { "title": "Free note 1 entered on the sign-up.", "type": "string" }, "free_note_two": { "title": "Free note 2 entered on the sign-up.", "type": "string" }, "free_note_three": { "title": "Free note 3 entered on the sign-up.", "type": "string" }, "free_note_four": { "title": "Free note 4 entered on the sign-up.", "type": "string" }, "product": { "title": "Product the sign-up is billed with.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem13" } ] }, "invoice_products": { "title": "Product items added to the invoice of the sign-up.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventSignUpProductItem3" } }, "generate_date_end": { "title": "End date of the generated bookings for the sign-up.", "type": "string", "format": "date-time" }, "variant": { "title": "Event variant the sign-up belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventVariant" } ] }, "invitation": { "title": "Invitation the sign-up was made with.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventInvitation5" } ] }, "event_access_budget": { "title": "Access budget used for the sign-up.", "oneOf": [ { "$ref": "#\/components\/schemas\/EventAccessBudget4" } ] }, "media_questionnaire_answer": { "title": "Answer to the questionnaire of the event.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer11" } ] }, "secondary_media_questionnaire_answer": { "title": "Answer of a further questionnaire sent to the signup (mass notification with questionnaire\ndraft) while mediaQuestionnaireAnswer already holds the answer to the sign-up form.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer11" } ] }, "self_check_in": { "title": "Participant checked in with the self-service check-in.", "type": "boolean" }, "self_check_out": { "title": "Participant checked out with the self-service check-out.", "type": "boolean" }, "self_check_in_date": { "title": "Time of the self-service check-in.", "type": "string", "format": "date-time" }, "self_check_out_date": { "title": "Time of the self-service check-out.", "type": "string", "format": "date-time" }, "reminded_of_absence": { "title": "Time the guardian was reminded of an absence.", "type": "string", "format": "date-time" }, "trial": { "title": "Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of\nthe person's trial pass (eventAccessBudget with sourceType trial)", "type": "boolean" }, "trial_channel": { "title": "Who booked the trial date: app, trainer, office", "type": "string" }, "trial_session_number": { "title": "Number of this trial date within the pass (1 = first), for \"Schnuppern 2\/3\"", "type": "integer" }, "trial_session_max": { "title": "Trial dates of the pass, for \"Schnuppern 2\/3\"", "type": "integer" }, "confirmed_date": { "title": "Time the sign-up was confirmed.", "type": "string", "format": "date-time" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "bib_number": { "title": "Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig.", "description": "Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.", "type": "integer" }, "bib_label": { "title": "Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.", "type": "string" }, "bib_number_assigned_at": { "title": "Time the bib number was assigned.", "type": "string", "format": "date-time" }, "chip_code": { "title": "Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.", "type": "string" }, "ticket_code": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Code des Tickets f\u00fcr den Check-in (QR-Code).", "description": "Eindeutig \u00fcber alle Events, nicht erratbar. Nur in eigenen Bestellungen und f\u00fcr die Verwaltung.", "type": "string" }, "ticket_checked_in_at": { "title": "Ticketverkauf: Zeitpunkt des Check-ins (Einlass). Ein zweiter Scan wird abgewiesen.", "type": "string", "format": "date-time" }, "ticket_checked_in_by": { "title": "Ticketverkauf: wer eingecheckt hat (Benutzername).", "type": "string" }, "timing_tracking_consent": { "title": "Einwilligung in das GPS-Live-Tracking waehrend des Events.", "type": "boolean" }, "timing_tracking_consent_date": { "title": "Time the participant consented to timing and tracking.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "BaseEventSignUpGroup": { "properties": { "direct_billing_token": { "title": "Token of the invoice to pay online (direct billing): all sign-ups of a group share one invoice.", "type": "string" }, "id": { "title": "Primary key of the sign-up group.", "description": "Internal ID.", "type": "integer" }, "sign_ups": { "title": "Sign-ups that belong to the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEventSignUp18" } } }, "type": "object" }, "BaseEventSignUpGroup2": { "properties": { "direct_billing_token": { "title": "Token of the invoice to pay online (direct billing): all sign-ups of a group share one invoice.", "type": "string" }, "id": { "title": "Primary key of the sign-up group.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the person who signs up the group.", "type": "string" }, "external": { "title": "The sign-up group was made by an external party.", "type": "boolean" }, "billed": { "title": "The sign-up group was billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseEventSignUpGroup3": { "properties": { "direct_billing_token": { "title": "Token of the invoice to pay online (direct billing): all sign-ups of a group share one invoice.", "type": "string" }, "id": { "title": "Primary key of the sign-up group.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the person who signs up the group.", "type": "string" }, "external": { "title": "The sign-up group was made by an external party.", "type": "boolean" }, "billed": { "title": "The sign-up group was billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseEventSignUpProductItem": { "type": "object" }, "BaseEventSignUpProductItem2": { "type": "object" }, "BaseEventSignUpProductItem3": { "properties": { "id": { "title": "Primary key of the product item.", "description": "Internal ID.", "type": "integer" }, "event_sign_up": { "title": "Sign-up the product item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp7" } ] }, "product": { "title": "Product that is billed.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem13" } ] }, "quantity": { "title": "Quantity of the product.", "type": "number", "format": "float" }, "billed": { "title": "The product item was billed.", "type": "boolean" } }, "type": "object" }, "BaseEventSignUpTest": { "properties": { "signup_allowed": { "type": "boolean" }, "signup_waitlist_allowed": { "type": "boolean" }, "signup_delete_allowed": { "type": "boolean" }, "signup_after_upgrade_allowed": { "type": "boolean" }, "signup_explicitly_disabled": { "type": "boolean" }, "signup_require_add_bank_account": { "type": "boolean" }, "signup_requires_login": { "type": "boolean" }, "signup_invoice_address_required": { "type": "boolean" }, "signup_free_capacity": { "type": "number" }, "signup_max_capacity": { "type": "number" }, "signup_fully_booked": { "title": "Only for an event with hidden people limit (globally or per event) and the opt-in setting\n`event_booking_show_fully_booked_if_people_limit_hidden`: no free place is left. The numbers\nthemselves are never sent for such an event.", "type": "boolean" }, "signup_min_participants_reached": { "type": "boolean" }, "signup_group_available": { "title": "Only with the query param `groupSize`: the event (or booking) has a free place for\nevery person of a group of that size. Groups are never put onto the wait list.", "description": "Always false while group sign-ups are switched off (`event_sign_up_group_enabled`).", "type": "boolean" }, "signup_require_add_access_tag": { "type": "boolean" }, "view_participants_allowed": { "type": "boolean" }, "view_participant_grid_allowed": { "type": "boolean" }, "can_track_time": { "type": "boolean" }, "signup_via_budget": { "type": "boolean" }, "budget_remaining": { "type": "number" } }, "type": "object" }, "BaseEventSignUpTrainerTest": { "properties": { "signup_allowed": { "type": "boolean" }, "signup_waitlist_allowed": { "type": "boolean" }, "trainer_can_track_time": { "type": "boolean" }, "trainer_can_edit_scoreboard": { "title": "The trainer may enter score and match activities (event type allows it and the\nevent has a scoreboard).", "type": "boolean" } }, "type": "object" }, "BaseEventVariant": { "properties": { "id": { "title": "Primary key of the event variant.", "description": "Internal ID.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "BaseLocation": { "properties": { "id": { "title": "Primary key of the location.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location.", "description": "Used in links instead of the ID.", "type": "string" }, "location_type": { "title": "Type of the location, for example room, hall or outdoor area.", "type": "string" }, "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "opening_hours_monday": { "title": "Opening hours on Monday.", "type": "string" }, "opening_hours_tuesday": { "title": "Opening hours on Tuesday.", "type": "string" }, "opening_hours_wednesday": { "title": "Opening hours on Wednesday.", "type": "string" }, "opening_hours_thursday": { "title": "Opening hours on Thursday.", "type": "string" }, "opening_hours_friday": { "title": "Opening hours on Friday.", "type": "string" }, "opening_hours_saturday": { "title": "Opening hours on Saturday.", "type": "string" }, "opening_hours_sunday": { "title": "Opening hours on Sunday.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory18" } } }, "type": "object" }, "BaseLocation10": { "properties": { "id": { "title": "Primary key of the location.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location.", "description": "Used in links instead of the ID.", "type": "string" }, "location_type": { "title": "Type of the location, for example room, hall or outdoor area.", "type": "string" }, "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "BaseLocation15": { "properties": { "id": { "title": "Primary key of the location.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location.", "description": "Used in links instead of the ID.", "type": "string" }, "location_type": { "title": "Type of the location, for example room, hall or outdoor area.", "type": "string" }, "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory4" } } }, "type": "object" }, "BaseLocation2": { "properties": { "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" } }, "type": "object" }, "BaseLocation22": { "properties": { "id": { "title": "Primary key of the location.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location.", "description": "Used in links instead of the ID.", "type": "string" }, "location_type": { "title": "Type of the location, for example room, hall or outdoor area.", "type": "string" }, "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage9" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory27" } } }, "type": "object" }, "BaseLocation25": { "properties": { "id": { "title": "Primary key of the location.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location.", "description": "Used in links instead of the ID.", "type": "string" }, "location_type": { "title": "Type of the location, for example room, hall or outdoor area.", "type": "string" }, "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "BaseLocation3": { "properties": { "id": { "title": "Primary key of the location.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location.", "description": "Used in links instead of the ID.", "type": "string" }, "location_type": { "title": "Type of the location, for example room, hall or outdoor area.", "type": "string" }, "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory16" } } }, "type": "object" }, "BaseLocation32": { "properties": { "id": { "title": "Primary key of the location.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location.", "description": "Used in links instead of the ID.", "type": "string" }, "location_type": { "title": "Type of the location, for example room, hall or outdoor area.", "type": "string" }, "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory12" } } }, "type": "object" }, "BaseLocation33": { "properties": { "id": { "title": "Primary key of the location.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location.", "description": "Used in links instead of the ID.", "type": "string" }, "location_type": { "title": "Type of the location, for example room, hall or outdoor area.", "type": "string" }, "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory13" } } }, "type": "object" }, "BaseLocation4": { "properties": { "id": { "title": "Primary key of the location.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location.", "description": "Used in links instead of the ID.", "type": "string" }, "location_type": { "title": "Type of the location, for example room, hall or outdoor area.", "type": "string" }, "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "opening_hours_monday": { "title": "Opening hours on Monday.", "type": "string" }, "opening_hours_tuesday": { "title": "Opening hours on Tuesday.", "type": "string" }, "opening_hours_wednesday": { "title": "Opening hours on Wednesday.", "type": "string" }, "opening_hours_thursday": { "title": "Opening hours on Thursday.", "type": "string" }, "opening_hours_friday": { "title": "Opening hours on Friday.", "type": "string" }, "opening_hours_saturday": { "title": "Opening hours on Saturday.", "type": "string" }, "opening_hours_sunday": { "title": "Opening hours on Sunday.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true } }, "type": "object" }, "BaseLocation6": { "properties": { "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } } }, "type": "object" }, "BaseLocation8": { "properties": { "id": { "title": "Primary key of the location.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location.", "description": "Used in links instead of the ID.", "type": "string" }, "location_type": { "title": "Type of the location, for example room, hall or outdoor area.", "type": "string" }, "in_contact_center": { "title": "The location is shown in the contact center.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true } }, "type": "object" }, "BaseLocationLocationType": { "properties": { "id": { "title": "Identifier of the location type.", "description": "For example room or hall.", "type": "string" }, "name": { "title": "Name of the location type.", "type": "string" }, "view_order": { "title": "Sort order of the location type in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseLocationLocationType2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BaseLocationPlan": { "properties": { "aspectRatio": { "title": "Aspect ratio of the background image, null when the dimensions are unknown.", "type": "number", "format": "float" }, "id": { "title": "Primary key of the location plan.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the location plan.", "description": "Used in links instead of the ID.", "type": "string" }, "floor_level": { "title": "Free text floor label, matches BaseBookable::getFloorLevel()", "type": "string" }, "sort_order": { "title": "Order of the floor tabs within one location", "type": "integer" }, "plan_mode": { "title": "Mode of the plan, for example grid or image.", "type": "string" }, "image_width": { "title": "Pixel width of the background image. Only used for the aspect ratio, the\nitem coordinates themselves are normalized and therefore resolution independent.", "type": "integer" }, "image_height": { "title": "Height of the plan image in pixels.", "type": "integer" }, "grid_columns": { "title": "Number of columns of the grid.", "type": "integer" }, "grid_rows": { "title": "Number of rows of the grid.", "type": "integer" }, "default_horizon_hours": { "title": "How far ahead the status endpoint looks for the next booking, in hours.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseLocationPlan2": { "properties": { "floor_level": { "title": "Free text floor label, matches BaseBookable::getFloorLevel()", "type": "string" }, "sort_order": { "title": "Order of the floor tabs within one location", "type": "integer" }, "plan_mode": { "title": "Mode of the plan, for example grid or image.", "type": "string" }, "image_width": { "title": "Pixel width of the background image. Only used for the aspect ratio, the\nitem coordinates themselves are normalized and therefore resolution independent.", "type": "integer" }, "image_height": { "title": "Height of the plan image in pixels.", "type": "integer" }, "grid_columns": { "title": "Number of columns of the grid.", "type": "integer" }, "grid_rows": { "title": "Number of rows of the grid.", "type": "integer" }, "default_horizon_hours": { "title": "How far ahead the status endpoint looks for the next booking, in hours.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "BaseLocationPlanItem": { "properties": { "plan": { "type": "integer" }, "displayLabel": { "title": "Label actually shown on the plan: the manual label wins, otherwise the\ncached bookable name.", "type": "string" }, "id": { "title": "Primary key of the plan item.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the plan item.", "description": "Used instead of the ID.", "type": "string" }, "item_type": { "title": "Type of the item, for example seat, table or label.", "type": "string" }, "shape": { "title": "Shape of the item on the plan.", "type": "string" }, "pos_x": { "title": "Left edge, normalized 0.0 - 1.0", "type": "number", "format": "float" }, "pos_y": { "title": "Top edge, normalized 0.0 - 1.0", "type": "number", "format": "float" }, "width": { "title": "Width of the item in plan units.", "type": "number", "format": "float" }, "height": { "title": "Height of the item in plan units.", "type": "number", "format": "float" }, "rotation": { "title": "Rotation of the item in degrees.", "type": "number", "format": "float" }, "z_index": { "title": "Stacking order of the item on the plan.", "type": "integer" }, "label": { "title": "Overrides the bookable name on the plan.", "type": "string" }, "icon": { "title": "Icon shown on the item.", "type": "string" }, "show_label": { "title": "Show the label of the item.", "type": "boolean" }, "show_status": { "title": "Show the status of the item.", "type": "boolean" }, "show_next": { "title": "Show the next booking of the item.", "type": "boolean" }, "seat_row": { "title": "Seat: row (\"5\", \"B\") as printed on the ticket.", "type": "string" }, "seat_number": { "title": "Seat: number within the row.", "type": "string" }, "seat_zone": { "title": "Seat: price zone (\"A\", \"Loge\"). An event's ticket category with the same\nPredefinedBillingItem::ticketSeatZone may be booked on it; without a zone every category may.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "color": { "title": "Background color as hex value.", "type": "string" }, "fg_color": { "title": "Foreground color as hex value.", "type": "string" } }, "type": "object" }, "BaseLocationPlanItem2": { "properties": { "item_type": { "title": "Type of the item, for example seat, table or label.", "type": "string" }, "shape": { "title": "Shape of the item on the plan.", "type": "string" }, "pos_x": { "title": "Left edge, normalized 0.0 - 1.0", "type": "number", "format": "float" }, "pos_y": { "title": "Top edge, normalized 0.0 - 1.0", "type": "number", "format": "float" }, "width": { "title": "Width of the item in plan units.", "type": "number", "format": "float" }, "height": { "title": "Height of the item in plan units.", "type": "number", "format": "float" }, "rotation": { "title": "Rotation of the item in degrees.", "type": "number", "format": "float" }, "z_index": { "title": "Stacking order of the item on the plan.", "type": "integer" }, "label": { "title": "Overrides the bookable name on the plan.", "type": "string" }, "icon": { "title": "Icon shown on the item.", "type": "string" }, "show_label": { "title": "Show the label of the item.", "type": "boolean" }, "show_status": { "title": "Show the status of the item.", "type": "boolean" }, "show_next": { "title": "Show the next booking of the item.", "type": "boolean" }, "seat_row": { "title": "Seat: row (\"5\", \"B\") as printed on the ticket.", "type": "string" }, "seat_number": { "title": "Seat: number within the row.", "type": "string" }, "seat_zone": { "title": "Seat: price zone (\"A\", \"Loge\"). An event's ticket category with the same\nPredefinedBillingItem::ticketSeatZone may be booked on it; without a zone every category may.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillReminder": { "properties": { "id": { "title": "Primary key of the bill reminder.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the reminder level, for example first reminder.", "type": "string" }, "global_default": { "title": "Default reminder for all companies.", "type": "boolean" }, "bill_reminder_count": { "title": "Level of the reminder, starting at 1.", "type": "integer" }, "template": { "title": "Document template of the reminder.", "oneOf": [ { "$ref": "#\/components\/schemas\/FlexibleLatexTemplate" } ] }, "predefined_billing_item": { "title": "Billing item charged with the reminder fee.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem11" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillReminder2": { "properties": { "id": { "title": "Primary key of the bill reminder.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the reminder level, for example first reminder.", "type": "string" }, "global_default": { "title": "Default reminder for all companies.", "type": "boolean" }, "bill_reminder_count": { "title": "Level of the reminder, starting at 1.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingDryRun": { "properties": { "id": { "title": "Primary key of the billing dry run.", "description": "Internal ID.", "type": "integer" }, "billing_payment_profile": { "title": "Payment profile used for the dry run.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } ] }, "status": { "title": "Status of the dry run, for example running or finished.", "type": "string" }, "billing_date": { "title": "Billing date used for the dry run.", "type": "string", "format": "date-time" }, "started_at": { "title": "Time the dry run started.", "type": "string", "format": "date-time" }, "finished_at": { "title": "Time the dry run finished.", "type": "string", "format": "date-time" }, "company_count": { "title": "Number of companies checked.", "type": "integer" }, "invoice_count": { "title": "Number of invoices that would be created.", "type": "integer" }, "saved_invoice_count": { "title": "Number of invoices that were saved.", "type": "integer" }, "skipped_invoice_count": { "title": "Number of invoices that were skipped.", "type": "integer" }, "position_count": { "title": "Number of positions on all invoices.", "type": "integer" }, "mail_count": { "title": "Number of invoices sent by e-mail.", "type": "integer" }, "postal_count": { "title": "Number of invoices sent by post.", "type": "integer" }, "sum_netto": { "title": "Sum of the net values.", "type": "number", "format": "float" }, "sum_brutto": { "title": "Sum of the gross values.", "type": "number", "format": "float" }, "sum_tax": { "title": "Sum of the tax values.", "type": "number", "format": "float" }, "log_length": { "title": "Length of the log of the dry run.", "type": "integer" }, "stored_item_count": { "title": "Number of items stored by the dry run.", "type": "integer" }, "error_message": { "title": "Error message of the dry run.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "BillingDryRun2": { "properties": { "billing_payment_profile": { "title": "Payment profile used for the dry run.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingPaymentProfile6" } ] }, "billing_date": { "title": "Billing date used for the dry run.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingDryRun3": { "properties": { "id": { "title": "Primary key of the billing dry run.", "description": "Internal ID.", "type": "integer" }, "billing_payment_profile": { "title": "Payment profile used for the dry run.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } ] }, "triggered_by_user": { "title": "Login user who started the dry run.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "status": { "title": "Status of the dry run, for example running or finished.", "type": "string" }, "billing_date": { "title": "Billing date used for the dry run.", "type": "string", "format": "date-time" }, "started_at": { "title": "Time the dry run started.", "type": "string", "format": "date-time" }, "finished_at": { "title": "Time the dry run finished.", "type": "string", "format": "date-time" }, "company_count": { "title": "Number of companies checked.", "type": "integer" }, "invoice_count": { "title": "Number of invoices that would be created.", "type": "integer" }, "saved_invoice_count": { "title": "Number of invoices that were saved.", "type": "integer" }, "skipped_invoice_count": { "title": "Number of invoices that were skipped.", "type": "integer" }, "position_count": { "title": "Number of positions on all invoices.", "type": "integer" }, "mail_count": { "title": "Number of invoices sent by e-mail.", "type": "integer" }, "postal_count": { "title": "Number of invoices sent by post.", "type": "integer" }, "sum_netto": { "title": "Sum of the net values.", "type": "number", "format": "float" }, "sum_brutto": { "title": "Sum of the gross values.", "type": "number", "format": "float" }, "sum_tax": { "title": "Sum of the tax values.", "type": "number", "format": "float" }, "log_length": { "title": "Length of the log of the dry run.", "type": "integer" }, "stored_item_count": { "title": "Number of items stored by the dry run.", "type": "integer" }, "error_message": { "title": "Error message of the dry run.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "BillingDryRun4": { "properties": { "billing_payment_profile": { "title": "Payment profile used for the dry run.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingPaymentProfile8" } ] }, "billing_date": { "title": "Billing date used for the dry run.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingDryRunItem": { "properties": { "id": { "title": "Primary key of the dry run item.", "description": "Internal ID.", "type": "integer" }, "company_id": { "title": "ID of the company to be billed.", "type": "integer" }, "company_number": { "title": "Number of the company to be billed.", "type": "string" }, "company_name": { "title": "Name of the company to be billed.", "type": "string" }, "source": { "title": "Source of the item, for example event or membership.", "type": "string" }, "accounting_type_name": { "title": "Name of the accounting type.", "type": "string" }, "invoice_message": { "title": "Message that would be printed on the invoice.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" }, "due_date": { "title": "Due date of the invoice.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net value of the invoice.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax value of the invoice.", "type": "number", "format": "float" }, "position_count": { "title": "Number of positions on the invoice.", "type": "integer" }, "time_report_count": { "title": "Number of time reports included.", "type": "integer" }, "would_be_persisted": { "title": "The invoice would be saved in a real run.", "type": "boolean" }, "skip_reason": { "title": "Reason the invoice would be skipped.", "type": "string" }, "send_mail": { "title": "The invoice would be sent by e-mail.", "type": "boolean" }, "send_postal": { "title": "The invoice would be sent by post.", "type": "boolean" }, "recipient_email": { "title": "E-mail address the invoice would be sent to.", "type": "string" }, "positions": { "title": "Positions of the invoice as JSON.", "type": "array", "items": { "type": "object" } } }, "type": "object" }, "BillingItemType": { "required": [ "category", "type" ], "properties": { "id": { "title": "Primary key of the billing item type.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item type.", "type": "string" }, "fixed_price_addon_one_name": { "title": "Name of the first fixed price addon.", "type": "string" }, "fixed_price_addon_two_name": { "title": "Name of the second fixed price addon.", "type": "string" }, "fixed_price_addon_one_name_person": { "title": "Name of the first fixed price addon for persons.", "type": "string" }, "fixed_price_addon_two_name_person": { "title": "Name of the second fixed price addon for persons.", "type": "string" }, "category": { "title": "Category of the billing item type.", "type": "string", "enum": [ "project", "subscription", "bookable", "event", "shipping", "location" ] }, "type": { "title": "Type of the billing item type.", "type": "string", "enum": [ "subscription", "bookable-hour", "event-fixed", "sla", "hours", "days", "fixed", "internal" ] }, "unit": { "title": "Unit of the billing item type, for example piece or hour.", "type": "string" }, "force_repeating": { "title": "Items of this type always repeat.", "type": "boolean" }, "can_repeat": { "title": "Items of this type can repeat.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingItemType4": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingItemType6": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingPaymentProfile": { "properties": { "id": { "title": "Primary key of the payment profile.", "description": "Internal ID.", "type": "integer" }, "payout_type": { "title": "Type of payout, for example SEPA direct debit or transfer.", "type": "string" }, "auto_mode": { "title": "Payments are created automatically.", "type": "boolean" }, "is_default": { "title": "Default payment profile.", "type": "boolean" }, "is_event_default": { "title": "Default payment profile for events.", "type": "boolean" }, "is_donation_default": { "title": "Default payment profile for donations.", "type": "boolean" }, "execution_day": { "title": "Day of the month the payments are executed.", "type": "string" }, "next_execution_date": { "title": "Date of the next execution.", "type": "string", "format": "date-time" }, "booking_day": { "title": "Day of the month the payments are booked.", "type": "string" }, "next_booking_date": { "title": "Date of the next booking.", "type": "string", "format": "date-time" }, "billing_payout_account": { "title": "Payout account used for the payments.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingPayoutAccount3" } ] }, "force_billing_due_date_to_next_booking_date": { "title": "Force the due date of the invoice to the next booking date.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "BillingPaymentProfile10": { "properties": { "id": { "title": "Primary key of the payment profile.", "description": "Internal ID.", "type": "integer" }, "payout_type": { "title": "Type of payout, for example SEPA direct debit or transfer.", "type": "string" }, "auto_mode": { "title": "Payments are created automatically.", "type": "boolean" }, "is_default": { "title": "Default payment profile.", "type": "boolean" }, "is_event_default": { "title": "Default payment profile for events.", "type": "boolean" }, "is_donation_default": { "title": "Default payment profile for donations.", "type": "boolean" }, "execution_day": { "title": "Day of the month the payments are executed.", "type": "string" }, "next_execution_date": { "title": "Date of the next execution.", "type": "string", "format": "date-time" }, "booking_day": { "title": "Day of the month the payments are booked.", "type": "string" }, "next_booking_date": { "title": "Date of the next booking.", "type": "string", "format": "date-time" }, "force_billing_due_date_to_next_booking_date": { "title": "Force the due date of the invoice to the next booking date.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "BillingPaymentProfile17": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingPaymentProfile19": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingPaymentProfile2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingPaymentProfile6": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingPaymentProfile8": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingPaymentProfile9": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BillingPayoutAccount": { "properties": { "id": { "title": "Primary key of the payout account.", "description": "Internal ID.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "BillingPayoutAccount2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "BillingPayoutAccount3": { "properties": { "id": { "title": "Primary key of the payout account.", "description": "Internal ID.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "BookingContentType": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "provide_tags": { "title": "Tags the content type provides, for example qualifications taught.", "type": "string" }, "require_tags": { "title": "Tags a trainer or resource needs to have for this content type.", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification6" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType10": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "provide_tags": { "title": "Tags the content type provides, for example qualifications taught.", "type": "string" }, "require_tags": { "title": "Tags a trainer or resource needs to have for this content type.", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification16" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType11": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification17" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType12": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification3" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType13": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification18" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType14": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification19" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType15": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification20" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType16": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification21" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType17": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification22" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType18": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification25" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType19": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification26" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType20": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification27" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType21": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification28" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType22": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification29" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType23": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification30" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType24": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification31" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType25": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification32" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType26": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification5" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType27": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification33" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType28": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification34" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType29": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification35" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType3": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification7" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType30": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification36" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType31": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification37" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType32": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification38" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType33": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification39" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType34": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification40" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType35": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification41" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType4": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification10" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType5": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification11" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType6": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification12" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType7": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification13" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType8": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification14" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingContentType9": { "properties": { "id": { "title": "Primary key of the content type.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Kurzname for compact UI labels (e.g. calendars, badges).", "type": "string" }, "required_qualification": { "title": "R05\/L18: the qualification a performing person of appointments of this type should\nhold (\u00dcbungsleiter of a course, Pausenaufsicht, ...). Checked with the same group\/\nranking rules as shifts; employee and linked trainer qualifications both count.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification15" } ] }, "qualification_match_mode": { "title": "How the required tags are matched against the qualifications.", "type": "string" }, "availability": { "title": "Bookings of this content type mark the resource as available.", "type": "boolean" }, "appointment": { "title": "Bookings of this content type are appointments.", "type": "boolean" }, "color": { "title": "Predefined color used for bookings of this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingPredefinedColor" } ] }, "require_single_participant": { "title": "Bookings of this content type need exactly one participant.", "type": "boolean" }, "require_participant_contact": { "title": "Participants of this content type must have contact details.", "type": "boolean" }, "require_participant_address": { "title": "Participants of this content type must have an address.", "type": "boolean" }, "require_participant_birthday": { "title": "Participants of this content type must have a birthday.", "type": "boolean" }, "default_time_in_minutes": { "title": "Default length of a booking of this content type in minutes.", "type": "integer" }, "self_service_selectable": { "title": "Whether this content type may be picked by a customer \/ trainer in the self service portal.", "description": "Off by default so existing installations keep the current behaviour.", "type": "boolean" }, "trainer_availability_mode": { "title": "Controls whether a self service booking of this content type also picks the availability of a\ntrainer: NONE (default), OPTIONAL or REQUIRED.", "type": "string" }, "self_service_bookable_types": { "title": "Restricts the bookable types this content type is offered for in the self service booking.", "description": "An empty collection means \"every bookable type\".", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseBookableBookableType" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BookingPredefinedColor": { "properties": { "id": { "title": "Primary key of the color.", "description": "Internal ID.", "type": "integer" }, "color": { "title": "Color value, for example a hex code.", "type": "string" }, "default_for_availability": { "title": "Default color for availability bookings.", "type": "boolean" }, "default_for_appointment": { "title": "Default color for appointments.", "type": "boolean" }, "default_for_blocking": { "title": "Default color for blocking bookings.", "type": "boolean" }, "availability": { "title": "The color can be used for availability bookings.", "type": "boolean" }, "appointment": { "title": "The color can be used for appointments.", "type": "boolean" }, "blocking": { "title": "The color can be used for blocking bookings.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "BuchhaltungsButlerStatus": { "properties": { "enabled": { "type": "boolean" }, "configured": { "title": "Sind alle API-Zugangsdaten hinterlegt?", "type": "boolean" }, "connected": { "title": "Ergebnis des Verbindungstests (null = nicht getestet)", "type": "boolean" }, "message": { "title": "Detail-Meldung (z.B. Fehlermeldung des Verbindungstests)", "type": "string" }, "pull_incoming_invoices_enabled": { "type": "boolean" }, "pull_transactions_enabled": { "type": "boolean" }, "pull_days_back": { "type": "integer" }, "sync_last_run": { "title": "Letzter Lauf des Sync-Cronjobs", "type": "string", "format": "date-time" }, "sync_next_run": { "title": "N\u00e4chster geplanter Lauf des Sync-Cronjobs", "type": "string", "format": "date-time" }, "sync_running": { "title": "L\u00e4uft der Sync gerade?", "type": "boolean" }, "sync_last_result": { "title": "Ergebnis-Ausgabe des letzten Sync-Laufs", "type": "string" } }, "type": "object" }, "CRMCompany": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "secondary_name": { "title": "Second name line of the company.", "type": "string" }, "direct_dial": { "title": "Direct dial number of the company.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices.", "type": "string" }, "send_invoice_email": { "title": "Send invoices by e-mail.", "type": "boolean" }, "send_invoice_letter": { "title": "Send invoices by letter.", "type": "boolean" }, "time_report_email": { "title": "E-mail address for time reports.", "type": "string" }, "payment_goal": { "title": "Payment term of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "payment_interval": { "title": "Interval of the payments.", "type": "string" }, "vatid": { "title": "VAT identification number.", "type": "string" }, "taxnumber": { "title": "Tax number of the company.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "tax": { "title": "Tax rate used for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "info": { "title": "Information about the company.", "type": "string" }, "number": { "title": "Customer or supplier number of the company.", "type": "string" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Company number as text, including prefix.", "type": "string" }, "is_customer": { "title": "The company is a customer.", "type": "boolean" }, "is_supplier": { "title": "The company is a supplier.", "type": "boolean" }, "is_other": { "title": "The company is neither customer nor supplier.", "type": "boolean" }, "is_member": { "title": "The company is a member.", "type": "boolean" }, "archived": { "title": "The company is archived.", "type": "boolean" }, "category": { "title": "Category of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } ] }, "visible_for_customer": { "title": "Whether the company is visible to the customer.", "type": "boolean" }, "founding_date": { "title": "Founding date of the company.", "type": "string", "format": "date-time" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "CRMCompany19": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "secondary_name": { "title": "Second name line of the company.", "type": "string" }, "direct_dial": { "title": "Direct dial number of the company.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices.", "type": "string" }, "send_invoice_email": { "title": "Send invoices by e-mail.", "type": "boolean" }, "send_invoice_letter": { "title": "Send invoices by letter.", "type": "boolean" }, "time_report_email": { "title": "E-mail address for time reports.", "type": "string" }, "payment_goal": { "title": "Payment term of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "payment_interval": { "title": "Interval of the payments.", "type": "string" }, "vatid": { "title": "VAT identification number.", "type": "string" }, "taxnumber": { "title": "Tax number of the company.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "tax": { "title": "Tax rate used for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "info": { "title": "Information about the company.", "type": "string" }, "number": { "title": "Customer or supplier number of the company.", "type": "string" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Company number as text, including prefix.", "type": "string" }, "is_customer": { "title": "The company is a customer.", "type": "boolean" }, "is_supplier": { "title": "The company is a supplier.", "type": "boolean" }, "is_other": { "title": "The company is neither customer nor supplier.", "type": "boolean" }, "is_member": { "title": "The company is a member.", "type": "boolean" }, "archived": { "title": "The company is archived.", "type": "boolean" }, "category": { "title": "Category of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } ] }, "visible_for_customer": { "title": "Whether the company is visible to the customer.", "type": "boolean" }, "founding_date": { "title": "Founding date of the company.", "type": "string", "format": "date-time" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "atags": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessTag" } }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "CRMCompany2": { "properties": { "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "secondary_name": { "title": "Second name line of the company.", "type": "string" }, "direct_dial": { "title": "Direct dial number of the company.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices.", "type": "string" }, "send_invoice_email": { "title": "Send invoices by e-mail.", "type": "boolean" }, "send_invoice_letter": { "title": "Send invoices by letter.", "type": "boolean" }, "time_report_email": { "title": "E-mail address for time reports.", "type": "string" }, "payment_goal": { "title": "Payment term of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "payment_interval": { "title": "Interval of the payments.", "type": "string" }, "vatid": { "title": "VAT identification number.", "type": "string" }, "taxnumber": { "title": "Tax number of the company.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "tax": { "title": "Tax rate used for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "info": { "title": "Information about the company.", "type": "string" }, "is_customer": { "title": "The company is a customer.", "type": "boolean" }, "is_supplier": { "title": "The company is a supplier.", "type": "boolean" }, "is_other": { "title": "The company is neither customer nor supplier.", "type": "boolean" }, "is_member": { "title": "The company is a member.", "type": "boolean" }, "archived": { "title": "The company is archived.", "type": "boolean" }, "category": { "title": "Category of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } ] }, "visible_for_customer": { "title": "Whether the company is visible to the customer.", "type": "boolean" }, "disabled_eb_start": { "title": "Start of the period in which electronic billing is disabled.", "type": "string", "format": "date-time" }, "disabled_eb_end": { "title": "End of the period in which electronic billing is disabled.", "type": "string", "format": "date-time" }, "start_time": { "title": "Start time of the company's relationship.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start of the relationship.", "type": "string" }, "end_time": { "title": "End time of the company's relationship.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end of the relationship.", "type": "string" }, "founding_date": { "title": "Founding date of the company.", "type": "string", "format": "date-time" }, "bank_max_value_per_month": { "title": "Maximum value per month for bank transactions.", "type": "number", "format": "float" }, "bank_disabled": { "title": "Whether bank transactions are disabled.", "type": "boolean" }, "bill_reminder_count": { "title": "Number of bill reminders sent.", "type": "integer" }, "bill_reminder_disabled": { "title": "Whether bill reminders are disabled.", "type": "boolean" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType6" }, "accounting_software_number": { "title": "Number of the entity in the accounting software.", "type": "string" }, "fixed_price_addon_one": { "title": "Price of the first fixed-price add-on.", "type": "number", "format": "float" }, "fixed_price_addon_two": { "title": "Price of the second fixed-price add-on.", "type": "number", "format": "float" }, "note": { "title": "This property is used to store a note for an entity", "type": "string" }, "created_from": { "title": "This field is used to store the origin of the entity, such as 'import', 'ticket', or 'manual'. Mainly used for statistics and tracking purposes.", "type": "string" } }, "type": "object" }, "CRMCompany21": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "secondary_name": { "title": "Second name line of the company.", "type": "string" }, "direct_dial": { "title": "Direct dial number of the company.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices.", "type": "string" }, "send_invoice_email": { "title": "Send invoices by e-mail.", "type": "boolean" }, "send_invoice_letter": { "title": "Send invoices by letter.", "type": "boolean" }, "time_report_email": { "title": "E-mail address for time reports.", "type": "string" }, "payment_goal": { "title": "Payment term of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "payment_interval": { "title": "Interval of the payments.", "type": "string" }, "vatid": { "title": "VAT identification number.", "type": "string" }, "taxnumber": { "title": "Tax number of the company.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "tax": { "title": "Tax rate used for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "info": { "title": "Information about the company.", "type": "string" }, "number": { "title": "Customer or supplier number of the company.", "type": "string" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Company number as text, including prefix.", "type": "string" }, "is_customer": { "title": "The company is a customer.", "type": "boolean" }, "is_supplier": { "title": "The company is a supplier.", "type": "boolean" }, "is_other": { "title": "The company is neither customer nor supplier.", "type": "boolean" }, "is_member": { "title": "The company is a member.", "type": "boolean" }, "archived": { "title": "The company is archived.", "type": "boolean" }, "category": { "title": "Category of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } ] }, "visible_for_customer": { "title": "Whether the company is visible to the customer.", "type": "boolean" }, "founding_date": { "title": "Founding date of the company.", "type": "string", "format": "date-time" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory16" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "CRMCompany23": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "secondary_name": { "title": "Second name line of the company.", "type": "string" }, "direct_dial": { "title": "Direct dial number of the company.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices.", "type": "string" }, "send_invoice_email": { "title": "Send invoices by e-mail.", "type": "boolean" }, "send_invoice_letter": { "title": "Send invoices by letter.", "type": "boolean" }, "time_report_email": { "title": "E-mail address for time reports.", "type": "string" }, "payment_goal": { "title": "Payment term of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "payment_interval": { "title": "Interval of the payments.", "type": "string" }, "vatid": { "title": "VAT identification number.", "type": "string" }, "taxnumber": { "title": "Tax number of the company.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "tax": { "title": "Tax rate used for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "info": { "title": "Information about the company.", "type": "string" }, "number": { "title": "Customer or supplier number of the company.", "type": "string" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Company number as text, including prefix.", "type": "string" }, "is_customer": { "title": "The company is a customer.", "type": "boolean" }, "is_supplier": { "title": "The company is a supplier.", "type": "boolean" }, "is_other": { "title": "The company is neither customer nor supplier.", "type": "boolean" }, "is_member": { "title": "The company is a member.", "type": "boolean" }, "archived": { "title": "The company is archived.", "type": "boolean" }, "category": { "title": "Category of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } ] }, "visible_for_customer": { "title": "Whether the company is visible to the customer.", "type": "boolean" }, "founding_date": { "title": "Founding date of the company.", "type": "string", "format": "date-time" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "CRMCompany24": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "number": { "title": "Customer or supplier number of the company.", "type": "string" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Company number as text, including prefix.", "type": "string" } }, "type": "object" }, "CRMCompany25": { "type": "object" }, "CRMCompany27": { "type": "object" }, "CRMCompany28": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" } }, "type": "object" }, "CRMCompany3": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "secondary_name": { "title": "Second name line of the company.", "type": "string" }, "direct_dial": { "title": "Direct dial number of the company.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices.", "type": "string" }, "send_invoice_email": { "title": "Send invoices by e-mail.", "type": "boolean" }, "send_invoice_letter": { "title": "Send invoices by letter.", "type": "boolean" }, "time_report_email": { "title": "E-mail address for time reports.", "type": "string" }, "payment_goal": { "title": "Payment term of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "payment_interval": { "title": "Interval of the payments.", "type": "string" }, "vatid": { "title": "VAT identification number.", "type": "string" }, "taxnumber": { "title": "Tax number of the company.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "tax": { "title": "Tax rate used for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "info": { "title": "Information about the company.", "type": "string" }, "number": { "title": "Customer or supplier number of the company.", "type": "string" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Company number as text, including prefix.", "type": "string" }, "is_customer": { "title": "The company is a customer.", "type": "boolean" }, "is_supplier": { "title": "The company is a supplier.", "type": "boolean" }, "is_other": { "title": "The company is neither customer nor supplier.", "type": "boolean" }, "is_member": { "title": "The company is a member.", "type": "boolean" }, "internal_contact": { "title": "Internal login user who is the contact for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/User6" } ] }, "managing_directors": { "title": "Managing directors of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson14" } }, "main_contacts": { "title": "Main contact persons of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson14" } }, "departments": { "title": "Departments of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMDepartment3" } }, "persons": { "title": "Persons of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson14" } }, "projects": { "title": "Projects of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMProject3" } }, "customerprofiles": { "title": "Customer profiles of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CustomerProfile" } }, "invoices": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice10" } }, "offers": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Offer6" } }, "archived": { "title": "The company is archived.", "type": "boolean" }, "category": { "title": "Category of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } ] }, "visible_for_customer": { "title": "Whether the company is visible to the customer.", "type": "boolean" }, "disabled_eb_start": { "title": "Start of the period in which electronic billing is disabled.", "type": "string", "format": "date-time" }, "disabled_eb_end": { "title": "End of the period in which electronic billing is disabled.", "type": "string", "format": "date-time" }, "start_time": { "title": "Start time of the company's relationship.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start of the relationship.", "type": "string" }, "end_time": { "title": "End time of the company's relationship.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end of the relationship.", "type": "string" }, "founding_date": { "title": "Founding date of the company.", "type": "string", "format": "date-time" }, "bank_max_value_per_month": { "title": "Maximum value per month for bank transactions.", "type": "number", "format": "float" }, "bank_disabled": { "title": "Whether bank transactions are disabled.", "type": "boolean" }, "bill_reminder_count": { "title": "Number of bill reminders sent.", "type": "integer" }, "bill_reminder_change_date": { "title": "Point in time the bill reminder was last changed.", "type": "string", "format": "date-time" }, "bill_reminder_disabled": { "title": "Whether bill reminders are disabled.", "type": "boolean" }, "linking_identifier": { "title": "Identifier that links the company to an external record.", "type": "string" }, "linked_person_count": { "title": "Number of linked persons.", "type": "integer" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "chatroom": { "title": "Chat room of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Chatroom10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory12" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "atags": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessTag" } }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "note": { "title": "This property is used to store a note for an entity", "type": "string" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "CRMCompany4": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "secondary_name": { "title": "Second name line of the company.", "type": "string" }, "direct_dial": { "title": "Direct dial number of the company.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices.", "type": "string" }, "send_invoice_email": { "title": "Send invoices by e-mail.", "type": "boolean" }, "send_invoice_letter": { "title": "Send invoices by letter.", "type": "boolean" }, "time_report_email": { "title": "E-mail address for time reports.", "type": "string" }, "payment_goal": { "title": "Payment term of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "payment_interval": { "title": "Interval of the payments.", "type": "string" }, "vatid": { "title": "VAT identification number.", "type": "string" }, "taxnumber": { "title": "Tax number of the company.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "tax": { "title": "Tax rate used for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "info": { "title": "Information about the company.", "type": "string" }, "number": { "title": "Customer or supplier number of the company.", "type": "string" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Company number as text, including prefix.", "type": "string" }, "is_customer": { "title": "The company is a customer.", "type": "boolean" }, "is_supplier": { "title": "The company is a supplier.", "type": "boolean" }, "is_other": { "title": "The company is neither customer nor supplier.", "type": "boolean" }, "is_member": { "title": "The company is a member.", "type": "boolean" }, "internal_contact": { "title": "Internal login user who is the contact for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/User7" } ] }, "managing_directors": { "title": "Managing directors of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson15" } }, "main_contacts": { "title": "Main contact persons of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson15" } }, "departments": { "title": "Departments of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMDepartment4" } }, "persons": { "title": "Persons of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson15" } }, "projects": { "title": "Projects of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMProject4" } }, "customerprofiles": { "title": "Customer profiles of the company.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CustomerProfile" } }, "invoices": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice11" } }, "offers": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Offer7" } }, "installations": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WPInstallation" } }, "slackchannel": { "title": "Slack channel of the company.", "type": "string" }, "chat_space": { "title": "Chat space of the company.", "type": "string" }, "googledrivefolder": { "title": "Google Drive folder of the company.", "type": "string" }, "googledrivefolderpublic": { "title": "Public Google Drive folder of the company.", "type": "string" }, "googledrivefoldergeneral": { "title": "General Google Drive folder of the company.", "type": "string" }, "archived": { "title": "The company is archived.", "type": "boolean" }, "category": { "title": "Category of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } ] }, "visible_for_customer": { "title": "Whether the company is visible to the customer.", "type": "boolean" }, "disabled_eb_start": { "title": "Start of the period in which electronic billing is disabled.", "type": "string", "format": "date-time" }, "disabled_eb_end": { "title": "End of the period in which electronic billing is disabled.", "type": "string", "format": "date-time" }, "start_time": { "title": "Start time of the company's relationship.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start of the relationship.", "type": "string" }, "end_time": { "title": "End time of the company's relationship.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end of the relationship.", "type": "string" }, "founding_date": { "title": "Founding date of the company.", "type": "string", "format": "date-time" }, "bank_max_value_per_month": { "title": "Maximum value per month for bank transactions.", "type": "number", "format": "float" }, "bank_disabled": { "title": "Whether bank transactions are disabled.", "type": "boolean" }, "bill_reminder_count": { "title": "Number of bill reminders sent.", "type": "integer" }, "bill_reminder_change_date": { "title": "Point in time the bill reminder was last changed.", "type": "string", "format": "date-time" }, "bill_reminder_disabled": { "title": "Whether bill reminders are disabled.", "type": "boolean" }, "linking_identifier": { "title": "Identifier that links the company to an external record.", "type": "string" }, "linked_person_count": { "title": "Number of linked persons.", "type": "integer" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "chatroom": { "title": "Chat room of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Chatroom10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory13" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "note": { "title": "This property is used to store a note for an entity", "type": "string" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "CRMCompany40": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "secondary_name": { "title": "Second name line of the company.", "type": "string" }, "direct_dial": { "title": "Direct dial number of the company.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices.", "type": "string" }, "send_invoice_email": { "title": "Send invoices by e-mail.", "type": "boolean" }, "send_invoice_letter": { "title": "Send invoices by letter.", "type": "boolean" }, "time_report_email": { "title": "E-mail address for time reports.", "type": "string" }, "payment_goal": { "title": "Payment term of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "payment_interval": { "title": "Interval of the payments.", "type": "string" }, "vatid": { "title": "VAT identification number.", "type": "string" }, "taxnumber": { "title": "Tax number of the company.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "tax": { "title": "Tax rate used for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "info": { "title": "Information about the company.", "type": "string" }, "number": { "title": "Customer or supplier number of the company.", "type": "string" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Company number as text, including prefix.", "type": "string" }, "is_customer": { "title": "The company is a customer.", "type": "boolean" }, "is_supplier": { "title": "The company is a supplier.", "type": "boolean" }, "is_other": { "title": "The company is neither customer nor supplier.", "type": "boolean" }, "is_member": { "title": "The company is a member.", "type": "boolean" }, "archived": { "title": "The company is archived.", "type": "boolean" }, "category": { "title": "Category of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } ] }, "visible_for_customer": { "title": "Whether the company is visible to the customer.", "type": "boolean" }, "founding_date": { "title": "Founding date of the company.", "type": "string", "format": "date-time" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory4" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "CRMCompany47": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "secondary_name": { "title": "Second name line of the company.", "type": "string" }, "direct_dial": { "title": "Direct dial number of the company.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices.", "type": "string" }, "send_invoice_email": { "title": "Send invoices by e-mail.", "type": "boolean" }, "send_invoice_letter": { "title": "Send invoices by letter.", "type": "boolean" }, "time_report_email": { "title": "E-mail address for time reports.", "type": "string" }, "payment_goal": { "title": "Payment term of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "payment_interval": { "title": "Interval of the payments.", "type": "string" }, "vatid": { "title": "VAT identification number.", "type": "string" }, "taxnumber": { "title": "Tax number of the company.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "tax": { "title": "Tax rate used for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "info": { "title": "Information about the company.", "type": "string" }, "number": { "title": "Customer or supplier number of the company.", "type": "string" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Company number as text, including prefix.", "type": "string" }, "is_customer": { "title": "The company is a customer.", "type": "boolean" }, "is_supplier": { "title": "The company is a supplier.", "type": "boolean" }, "is_other": { "title": "The company is neither customer nor supplier.", "type": "boolean" }, "is_member": { "title": "The company is a member.", "type": "boolean" }, "archived": { "title": "The company is archived.", "type": "boolean" }, "category": { "title": "Category of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } ] }, "visible_for_customer": { "title": "Whether the company is visible to the customer.", "type": "boolean" }, "founding_date": { "title": "Founding date of the company.", "type": "string", "format": "date-time" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory27" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "CRMCompany50": { "properties": { "id": { "title": "Primary key of the company.", "description": "Internal ID.", "type": "integer" }, "short_name": { "title": "Short name of the company.", "type": "string" }, "company_name": { "title": "Legal name of the company.", "type": "string" }, "secondary_name": { "title": "Second name line of the company.", "type": "string" }, "direct_dial": { "title": "Direct dial number of the company.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices.", "type": "string" }, "send_invoice_email": { "title": "Send invoices by e-mail.", "type": "boolean" }, "send_invoice_letter": { "title": "Send invoices by letter.", "type": "boolean" }, "time_report_email": { "title": "E-mail address for time reports.", "type": "string" }, "payment_goal": { "title": "Payment term of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "payment_interval": { "title": "Interval of the payments.", "type": "string" }, "vatid": { "title": "VAT identification number.", "type": "string" }, "taxnumber": { "title": "Tax number of the company.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "tax": { "title": "Tax rate used for the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "info": { "title": "Information about the company.", "type": "string" }, "number": { "title": "Customer or supplier number of the company.", "type": "string" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Company number as text, including prefix.", "type": "string" }, "is_customer": { "title": "The company is a customer.", "type": "boolean" }, "is_supplier": { "title": "The company is a supplier.", "type": "boolean" }, "is_other": { "title": "The company is neither customer nor supplier.", "type": "boolean" }, "is_member": { "title": "The company is a member.", "type": "boolean" }, "archived": { "title": "The company is archived.", "type": "boolean" }, "category": { "title": "Category of the company.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompanyCategory" } ] }, "visible_for_customer": { "title": "Whether the company is visible to the customer.", "type": "boolean" }, "founding_date": { "title": "Founding date of the company.", "type": "string", "format": "date-time" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "CRMCompany9": { "type": "object" }, "CRMCompanyCategory": { "properties": { "id": { "title": "Primary key of the company category.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the company category.", "type": "string" }, "description": { "title": "Description of the company category.", "type": "string" }, "deleted": { "title": "The category is deleted.", "type": "boolean" }, "global_default": { "title": "Default category for new companies.", "type": "boolean" }, "enabled_customer_portal": { "title": "Companies of this category may use the customer portal.", "type": "boolean" }, "g_drive_root_dir": { "title": "Root folder in Google Drive for companies of this category.", "type": "string" }, "g_drive_root_dir_archived": { "title": "Root folder in Google Drive for archived companies of this category.", "type": "string" }, "require_company_address": { "title": "An address must be entered for companies of this category.", "type": "boolean" }, "require_company_billing": { "title": "Billing details must be entered for companies of this category.", "type": "boolean" } }, "type": "object" }, "CRMDepartment": { "properties": { "id": { "title": "Primary key of the department.", "description": "Internal ID.", "type": "integer" }, "companies": { "title": "Companies the department belongs to.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMCompany" } }, "persons": { "title": "Persons assigned to the department.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" } }, "type": "object" }, "CRMDepartment3": { "properties": { "id": { "title": "Primary key of the department.", "description": "Internal ID.", "type": "integer" }, "companies": { "title": "Companies the department belongs to.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMCompany3" } }, "persons": { "title": "Persons assigned to the department.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson14" } }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory12" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" } }, "type": "object" }, "CRMDepartment4": { "properties": { "id": { "title": "Primary key of the department.", "description": "Internal ID.", "type": "integer" }, "companies": { "title": "Companies the department belongs to.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMCompany4" } }, "persons": { "title": "Persons assigned to the department.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson15" } }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory13" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" } }, "type": "object" }, "CRMPerson": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" } }, "type": "object" }, "CRMPerson10": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson100": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory28" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson102": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory30" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson103": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory32" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson104": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory34" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson106": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson14": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory12" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "note": { "title": "This property is used to store a note for an entity", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson15": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory13" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "note": { "title": "This property is used to store a note for an entity", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson2": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "ai_churn_risk_score": { "title": "K\u00fcndigungsrisiko 0-100 aus der KI-Bewertung (MemberChurnRiskHelper); nur f\u00fcr das Team.", "type": "integer" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "companies": { "title": "Companies the person belongs to.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMCompany" } }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson26": { "properties": { "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory23" } ] }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory38" } }, "note": { "title": "This property is used to store a note for an entity", "type": "string" }, "fixed_price_addon_one": { "title": "Price of the first fixed-price add-on.", "type": "number", "format": "float" }, "fixed_price_addon_two": { "title": "Price of the second fixed-price add-on.", "type": "number", "format": "float" }, "use_in_ai": { "title": "This property is used to mark an entity for syncing with a rag.", "type": "boolean" }, "only_personal_ai": { "title": "This property is used to only include the data for personal AI.", "type": "boolean" }, "created_from": { "title": "This field is used to store the origin of the entity, such as 'import', 'ticket', or 'manual'. Mainly used for statistics and tracking purposes.", "type": "string" } }, "type": "object" }, "CRMPerson27": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" } }, "type": "object" }, "CRMPerson3": { "properties": { "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory2" } ] }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "note": { "title": "This property is used to store a note for an entity", "type": "string" }, "fixed_price_addon_one": { "title": "Price of the first fixed-price add-on.", "type": "number", "format": "float" }, "fixed_price_addon_two": { "title": "Price of the second fixed-price add-on.", "type": "number", "format": "float" }, "use_in_ai": { "title": "This property is used to mark an entity for syncing with a rag.", "type": "boolean" }, "only_personal_ai": { "title": "This property is used to only include the data for personal AI.", "type": "boolean" }, "created_from": { "title": "This field is used to store the origin of the entity, such as 'import', 'ticket', or 'manual'. Mainly used for statistics and tracking purposes.", "type": "string" } }, "type": "object" }, "CRMPerson32": { "type": "object" }, "CRMPerson33": { "type": "object" }, "CRMPerson34": { "type": "object" }, "CRMPerson35": { "type": "object" }, "CRMPerson36": { "type": "object" }, "CRMPerson37": { "type": "object" }, "CRMPerson38": { "type": "object" }, "CRMPerson40": { "type": "object" }, "CRMPerson41": { "type": "object" }, "CRMPerson45": { "type": "object" }, "CRMPerson49": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson50": { "properties": { "last_name": { "type": "string" }, "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" } }, "type": "object" }, "CRMPerson53": { "type": "object" }, "CRMPerson54": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson59": { "properties": { "last_name": { "title": "Last name of the person.", "type": "string" }, "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson71": { "properties": { "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory54" } ] }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "note": { "title": "This property is used to store a note for an entity", "type": "string" }, "fixed_price_addon_one": { "title": "Price of the first fixed-price add-on.", "type": "number", "format": "float" }, "fixed_price_addon_two": { "title": "Price of the second fixed-price add-on.", "type": "number", "format": "float" }, "use_in_ai": { "title": "This property is used to mark an entity for syncing with a rag.", "type": "boolean" }, "only_personal_ai": { "title": "This property is used to only include the data for personal AI.", "type": "boolean" }, "created_from": { "title": "This field is used to store the origin of the entity, such as 'import', 'ticket', or 'manual'. Mainly used for statistics and tracking purposes.", "type": "string" } }, "type": "object" }, "CRMPerson9": { "type": "object" }, "CRMPerson91": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory18" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson93": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory22" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson94": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory23" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson95": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory24" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson96": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory25" } }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson97": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory26" } }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPerson99": { "properties": { "id": { "title": "Primary key of the person.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the person.", "type": "string" }, "last_name": { "title": "Last name of the person.", "type": "string" }, "number": { "title": "Member or customer number of the person.", "type": "integer" }, "manual_number": { "title": "Number set manually instead of the automatic number.", "type": "integer" }, "number_string": { "title": "Member or customer number as text, including prefix.", "type": "string" }, "gender": { "title": "Gender of the person.", "type": "string" }, "title": { "title": "Academic or other title of the person.", "type": "string" }, "position": { "title": "Position or role of the person.", "type": "string" }, "language": { "title": "Preferred language of the person.", "type": "string" }, "special_salutation": { "title": "Special salutation text for letters.", "type": "string" }, "form_of_salutation": { "title": "Form of salutation, for example formal or informal.", "type": "string" }, "birthday": { "title": "Birthday of the person.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the person.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "allow_photos": { "title": "Photos of the person may be taken and published.", "type": "boolean" }, "allow_leaving_alone": { "title": "The person may leave the event alone.", "type": "boolean" }, "authorized_pickup": { "title": "Persons who are allowed to pick up the person.", "type": "string" }, "needs_support": { "title": "The person needs support, for example for inclusion.", "type": "boolean" }, "support_description": { "title": "Description of the support the person needs.", "type": "string" }, "financial_support": { "title": "The person receives financial support.", "type": "boolean" }, "financial_support_number": { "title": "Number of the financial support.", "type": "string" }, "municipal_support": { "title": "The person receives municipal support.", "type": "boolean" }, "municipal_support_number": { "title": "Number of the municipal support.", "type": "string" }, "grade_level": { "title": "School grade level of the person.", "type": "integer" }, "school_class": { "title": "School class of the person.", "type": "string" }, "start_time": { "title": "Start of the membership or activity.", "type": "string", "format": "date-time" }, "start_time_reason": { "title": "Reason for the start.", "type": "string" }, "end_time": { "title": "End of the membership or activity.", "type": "string", "format": "date-time" }, "end_time_reason": { "title": "Reason for the end.", "type": "string" }, "confirmed_gtc_time": { "title": "Time the general terms and conditions were confirmed.", "type": "string", "format": "date-time" }, "chatbot_opt_in": { "title": "Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter\naktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.", "type": "boolean" }, "chatbot_opt_in_at": { "title": "Time the person opted in to the chatbot.", "type": "string", "format": "date-time" }, "chatbot_opt_in_text_version": { "title": "Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von\nder aktuellen Version ab, ist das Opt-in abgelaufen.", "type": "string" }, "app_usage_statistics_opt_out": { "title": "Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App.", "description": "Die App liest ihn aus den StaticData und schickt dann nichts mehr; die\ngezaehlten Aufrufe selbst haben keinen Bezug zur Person.", "type": "boolean" }, "crm_person_contact_data": { "title": "Contact data of the person, for example phone and e-mail.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonContactData" } }, "archived": { "title": "Whether the person is archived.", "type": "boolean" }, "subscribed_newsletter": { "title": "Whether the person subscribed to the newsletter.", "type": "boolean" }, "subscribed_magazine": { "title": "Whether the person subscribed to the magazine.", "type": "boolean" }, "printed_member_card": { "title": "Whether a member card has been printed for the person.", "type": "boolean" }, "has_login_user": { "title": "Whether the person has a login user.", "type": "boolean" }, "profile_picture_url": { "title": "URL of the profile picture of the person.", "type": "string" }, "log_book_staff": { "title": "Log book flag: staff.", "type": "boolean" }, "log_book_staff1": { "title": "Log book flag: staff, level 1.", "type": "boolean" }, "log_book_staff2": { "title": "Log book flag: staff, level 2.", "type": "boolean" }, "log_book_member": { "title": "Log book flag: member.", "type": "boolean" }, "log_book_trainer": { "title": "Log book flag: trainer.", "type": "boolean" }, "log_book_trainer1": { "title": "Log book flag: trainer, level 1.", "type": "boolean" }, "log_book_trainer2": { "title": "Log book flag: trainer, level 2.", "type": "boolean" }, "log_book_head_of_department": { "title": "Log book flag: head of department.", "type": "boolean" }, "log_book_supervisory_board": { "title": "Log book flag: supervisory board.", "type": "boolean" }, "log_book_board_of_directors": { "title": "Log book flag: board of directors.", "type": "boolean" }, "log_book_honorary_member": { "title": "Log book flag: honorary member.", "type": "boolean" }, "log_book_club_card_one": { "title": "Log book flag: club card.", "type": "boolean" }, "log_book_health_recovered": { "title": "Log book flag: recovered from illness.", "type": "boolean" }, "log_book_health_vaccinated": { "title": "Log book flag: vaccinated.", "type": "boolean" }, "log_book_health_vaccinated_addition": { "title": "Details of the vaccination.", "type": "string" }, "log_book_good_conduct": { "title": "Log book flag: certificate of good conduct.", "type": "boolean" }, "log_book_first_aid": { "title": "Log book flag: first aid training.", "type": "boolean" }, "log_book_measles_vaccination": { "title": "Log book flag: measles vaccination.", "type": "boolean" }, "sync_lanista": { "title": "Whether the person is synchronized with Lanista.", "type": "boolean" }, "category": { "title": "Person category.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPersonCategory" } ] }, "nickname": { "title": "Nickname of the person.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the person as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory27" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPersonCategory": { "properties": { "id": { "title": "Primary key of the person category.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the person category.", "type": "string" }, "name_plural": { "title": "Plural name of the person category.", "type": "string" }, "description": { "title": "Description of the person category.", "type": "string" }, "deleted": { "title": "The category is deleted.", "type": "boolean" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "enabled_customer_create_new": { "title": "Persons of this category may create new persons in the customer app.", "type": "boolean" }, "customer_register_min_number": { "title": "Minimum number of persons that can be registered together.", "type": "integer" }, "customer_add_ignore_invite_code": { "title": "Persons can be added without an invite code.", "type": "boolean" }, "customer_ui_allowed_ticket_types": { "title": "Ticket types that customers may create in the customer app.", "type": "string" }, "enabled_customer_ui_selection": { "title": "Customers may select the category in the customer app.", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "CRMPersonCategory2": { "type": "object" }, "CRMPersonCategory23": { "type": "object" }, "CRMPersonCategory54": { "type": "object" }, "CRMPersonContactData": { "properties": { "id": { "title": "Primary key of the contact data entry.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the contact data entry.", "type": "string" }, "value": { "title": "Value of the contact data entry, e.g. a phone number or e-mail address.", "type": "string" }, "generated_value": { "title": "Value generated from the entered value.", "type": "string" }, "contact_data_type": { "title": "Type of the contact data.", "oneOf": [ { "$ref": "#\/components\/schemas\/ContactDataType" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "CRMPersonContactData2": { "properties": { "id": { "title": "Primary key of the contact data entry.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the contact data entry.", "type": "string" }, "value": { "title": "Value of the contact data entry, e.g. a phone number or e-mail address.", "type": "string" }, "generated_value": { "title": "Value generated from the entered value.", "type": "string" }, "contact_data_type": { "title": "Type of the contact data.", "oneOf": [ { "$ref": "#\/components\/schemas\/ContactDataType" } ] }, "company": { "title": "Company the contact data belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "CRMPersonDurationStatistic": { "properties": { "contentTypeLabel": { "type": "string" }, "personId": { "type": "integer" }, "totalYears": { "title": "Get total duration in full years", "type": "integer" }, "totalRemainingMonths": { "title": "Get remaining months after full years", "type": "integer" }, "currentContinuousYears": { "title": "Get current continuous duration in full years", "type": "integer" }, "currentContinuousRemainingMonths": { "title": "Get remaining months of current continuous period after full years", "type": "integer" }, "isCurrentlyActive": { "title": "Check whether the current date lies within the latest continuous period", "type": "boolean" }, "totalFormatted": { "title": "Get formatted total duration string", "type": "string" }, "currentContinuousFormatted": { "title": "Get formatted current continuous duration string", "type": "string" }, "id": { "title": "Primary key of the duration statistic.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the statistic belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "content_type": { "title": "Logbook content type or CONTENT_TYPE_VOLUNTEER for the configured combined activity", "type": "string" }, "unified_category": { "title": "Optional unified category. NULL means aggregated across all categories for this content type.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory15" } ] }, "total_months": { "title": "Total months accumulated for this content type (across all periods, excluding gaps)", "type": "integer" }, "current_continuous_months": { "title": "Current continuous months without a gap longer than RESET_GAP_MONTHS", "type": "integer" }, "first_start": { "title": "The very first start date ever recorded for this content type", "type": "string", "format": "date-time" }, "current_start": { "title": "The start date of the current continuous period", "type": "string", "format": "date-time" }, "current_end": { "title": "The latest period end (NULL means open-ended; a future end can still be active)", "type": "string", "format": "date-time" }, "last_calculated": { "title": "When the statistics were last calculated", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMPersonHonorAnniversary": { "properties": { "personId": { "type": "integer" }, "contentTypeLabel": { "type": "string" }, "id": { "title": "Primary key of the honor anniversary.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the anniversary belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "content_type": { "title": "LOG_CONTENT_TYPE_MEMBER or CRMPersonDurationStatistic::CONTENT_TYPE_VOLUNTEER", "type": "string" }, "basis": { "title": "BASIS_TOTAL or BASIS_CURRENT", "type": "string" }, "years": { "title": "The anniversary in years (10, 25, 40 ...)", "type": "integer" }, "due_date": { "title": "Day the anniversary is reached, estimated from the monthly counter (first day of that month)", "type": "string", "format": "date-time" }, "reminder_sent": { "title": "When the office reminder listing this anniversary was sent", "type": "string", "format": "date-time" }, "greeting_sent": { "title": "When the congratulation with certificate was sent to the person", "type": "string", "format": "date-time" }, "handled": { "title": "When the honor was marked as done (certificate handed over); NULL = still open", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMPersonTemporaryAccess": { "properties": { "id": { "title": "Primary key of the temporary access.", "description": "Internal ID.", "type": "integer" }, "atags": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessTag" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "CRMPersonTemporaryAccess2": { "properties": { "id": { "title": "Primary key of the temporary access.", "description": "Internal ID.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "CRMProject": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject10": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject11": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject12": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject13": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject14": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject15": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject16": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject17": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject18": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany50" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User59" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject19": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject2": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "main_contacts": { "title": "Main contact persons of the project.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "employees": { "title": "Employees who work on the project.", "type": "array", "items": { "$ref": "#\/components\/schemas\/User14" } }, "items": { "title": "Items billed in the project.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMProjectItem3" } }, "googledrivefolder": { "title": "Google Drive folder of the project.", "type": "string" }, "googledrivefolderpublic": { "title": "Public Google Drive folder of the project.", "type": "string" }, "googledrivefoldergeneral": { "title": "General Google Drive folder of the project.", "type": "string" }, "googledrive_folder_invoice": { "title": "Google Drive folder for invoices of the project.", "type": "string" }, "googledrive_folder_offer": { "title": "Google Drive folder for offers of the project.", "type": "string" }, "googledrive_folder_contract": { "title": "Google Drive folder for contracts of the project.", "type": "string" }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject20": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject21": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject22": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject23": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject3": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany3" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User6" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject4": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany4" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User7" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject5": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject6": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject8": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProject9": { "properties": { "id": { "title": "Primary key of the project.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project.", "type": "string" }, "closed": { "title": "Time the project was closed.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the project was billed.", "type": "string", "format": "date-time" }, "number": { "title": "Number of the project.", "type": "string" }, "start": { "title": "Start of the project.", "type": "string", "format": "date-time" }, "end": { "title": "End of the project.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the project.", "type": "string" }, "company": { "title": "Company the project belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany19" } ] }, "internal_main_contact": { "title": "Internal login user who is the main contact.", "oneOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "category": { "title": "Category of the project.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategory" } ] }, "archived": { "title": "The project is archived.", "type": "boolean" }, "visible_for_customer": { "title": "The project is visible in the customer app.", "type": "boolean" }, "name_for_customer": { "title": "Name of the project shown to customers.", "type": "string" }, "invoice_email": { "title": "E-mail address for invoices of the project.", "type": "string" }, "time_report_email": { "title": "E-mail address for time reports of the project.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMProjectCategory": { "properties": { "id": { "title": "Primary key of the project category.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the project category.", "type": "string" }, "description": { "title": "Description of the project category.", "type": "string" }, "areas": { "title": "Areas the project category is assigned to.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMProjectCategoryArea" } }, "deleted": { "title": "The category is deleted.", "type": "boolean" } }, "type": "object" }, "CRMProjectCategoryArea": { "properties": { "id": { "title": "Primary key of the category area.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the area.", "type": "string" }, "description": { "title": "Description of the area.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "CRMProjectItem": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject5" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem10": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject18" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer10" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem11": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject19" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer11" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem12": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject20" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer12" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem13": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject21" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer13" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem2": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer2" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem3": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject2" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer14" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem4": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject8" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer15" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem5": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject9" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer16" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem6": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject10" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer17" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem7": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject22" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer19" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem8": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject17" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer9" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMProjectItem9": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "project": { "title": "Project the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject23" } ] }, "offer": { "title": "Offer the item was taken from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer18" } ] }, "start": { "title": "Start of the billed service.", "type": "string", "format": "date-time" }, "end": { "title": "End of the billed service.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the item was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" }, "goodwill": { "title": "The item is a goodwill item and is not charged.", "type": "boolean" } }, "type": "object" }, "CRMRecurrence": { "properties": { "id": { "title": "Primary key of the recurrence.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the recurrence, for example monthly.", "type": "string" }, "once": { "title": "The recurrence happens only once.", "type": "boolean" }, "allow_partial_on_eq_start_billing": { "title": "Allows partial billing if start and billed date are equal. primarily used for the first billing of a yearly contract", "type": "boolean" }, "date_string": { "title": "Date pattern of the recurrence as text.", "type": "string" }, "tolerance": { "title": "Tolerance in days around the recurrence date.", "type": "number", "format": "float" }, "deleted": { "title": "The recurrence is deleted.", "type": "boolean" }, "rounding_steps": { "title": "Steps used to round the recurrence.", "type": "integer" }, "month_factor": { "title": "Number of months between two recurrences.", "type": "integer" } }, "type": "object" }, "CRMSprint": { "properties": { "id": { "title": "Primary key of the sprint.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the sprint.", "type": "string" }, "state": { "title": "One of self::STATES", "type": "string" }, "start_date": { "title": "Start date of the sprint.", "type": "string", "format": "date-time" }, "end_date": { "title": "End date of the sprint.", "type": "string", "format": "date-time" }, "capacity_in_hours": { "title": "The work time the team can spend in this sprint", "type": "number", "format": "float" }, "view_order": { "title": "Sort order of the sprint in lists.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CRMSprint2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "CashRegister": { "properties": { "id": { "title": "Primary key of the cash register.", "description": "Internal ID.", "type": "integer" }, "code": { "title": "Kurzzeichen f\u00fcr die Belegnummer, etwa \"VH\" f\u00fcr Vereinsheim.", "type": "string" }, "ledger_account": { "title": "Das Bestandskonto dieser Kasse f\u00fcr die Bilanzierung.", "description": "Je Kasse ein eigenes Konto, sonst st\u00fcnden in der Bilanz beide Best\u00e4nde\nauf einer Zeile und lie\u00dfen sich nicht mehr trennen.", "oneOf": [ { "$ref": "#\/components\/schemas\/LedgerAccount" } ] }, "cost_center": { "title": "Die steuerliche Sph\u00e4re beim gemeinn\u00fctzigen Verein.", "description": "Eine Kasse geh\u00f6rt meist zu einem Bereich - die Kasse am Getr\u00e4nkestand\nzum wirtschaftlichen Gesch\u00e4ftsbetrieb, die Kasse der Gesch\u00e4ftsstelle\nzum ideellen Bereich.", "oneOf": [ { "$ref": "#\/components\/schemas\/CostCenter" } ] }, "is_active": { "title": "Stillgelegte Kassen nehmen keine Buchungen mehr an, bleiben aber mit\nihrem Buch bestehen - die Aufzeichnungen sind aufzubewahren.", "type": "boolean" }, "locked_through": { "title": "Bis zu welchem Tag das Kassenbuch abgeschlossen ist.", "description": "Der Kassenabschluss schiebt dieses Datum vor. Bis hierhin nimmt die\nKasse keine Bewegung mehr an - auch nicht am selben Tag: die\nChronologiepr\u00fcfung allein lie\u00df nach dem Monatsabschluss noch eine\nBewegung mit dem letzten Tag des Monats zu, und der abgeschlossene\nMonat w\u00e4re hinterher ein anderer gewesen als der abgeschlossene.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CashTransaction": { "properties": { "id": { "title": "Primary key of the cash transaction.", "description": "Internal ID.", "type": "integer" }, "cash_register": { "title": "Die Kasse, zu der diese Bewegung geh\u00f6rt.", "description": "Pflichtangabe: eine Kassenbewegung ohne Kasse h\u00e4tte keinen Bestand, an\ndem sie sich fortschreiben k\u00f6nnte.", "oneOf": [ { "$ref": "#\/components\/schemas\/CashRegister" } ] }, "sequence_number": { "title": "Fortlaufende Nummer im Kassenbuch der jeweiligen Kasse, l\u00fcckenlos ab 1.", "description": "Die L\u00fcckenlosigkeit ist der Grund f\u00fcr die Nummer: fehlt eine, ist eine\nBewegung entfernt worden. Sie wird deshalb von `CashBookService`\nvergeben und nicht vom Aufrufer gesetzt.", "type": "integer" }, "transaction_date": { "title": "Tag der Bewegung.", "type": "string", "format": "date-time" }, "type": { "title": "Type of the cash transaction, for example income or expense.", "type": "string" }, "gross_amount": { "title": "Der Betrag, der tats\u00e4chlich die Kasse wechselt - immer brutto und\nimmer positiv. Die Richtung steckt in `type`, nicht im Vorzeichen.", "description": "Ein Vorzeichen zus\u00e4tzlich zur Richtung w\u00e4re eine zweite Wahrheit \u00fcber\ndieselbe Sache; bei einer Ausgabe von -50 mit type=expense w\u00fcsste\nniemand, ob das nun eine Einnahme ist.", "type": "number", "format": "float" }, "tax_rate": { "title": "Steuersatz in Prozent, wie er auf dem Beleg steht.", "type": "number", "format": "float" }, "tax_amount": { "title": "Der Steueranteil des Bruttobetrags, aus Satz und Betrag gerechnet.", "type": "number", "format": "float" }, "balance_after": { "title": "Bestand der Kasse nach dieser Bewegung.", "type": "number", "format": "float" }, "document_number": { "title": "Belegnummer - die Nummer des Kassenbelegs, nicht die laufende Nummer.", "type": "string" }, "expense_category": { "title": "Die E\u00dcR-Kategorie - dieselbe Br\u00fccke wie am Sachkonto und am Anlagegut.", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "contra_ledger_account": { "title": "Das Gegenkonto f\u00fcr die Bilanzierung - die Kasse selbst ist die andere\nSeite und steht im Kontenrahmen fest.", "oneOf": [ { "$ref": "#\/components\/schemas\/LedgerAccount" } ] }, "cost_center": { "title": "Die steuerliche Sph\u00e4re beim gemeinn\u00fctzigen Verein.", "oneOf": [ { "$ref": "#\/components\/schemas\/CostCenter" } ] }, "incoming_invoice": { "title": "Die bar bezahlte Eingangsrechnung, falls es eine gibt.", "oneOf": [ { "$ref": "#\/components\/schemas\/IncomingInvoice3" } ] }, "invoice": { "title": "Die bar kassierte Ausgangsrechnung, falls es eine gibt.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice" } ] }, "journal_entry": { "title": "Der Buchungssatz, sofern die Bewegung verbucht wurde.", "description": "Nur bei Bilanzierung gesetzt. Bei der E\u00dcR bleibt er leer, weil es dort\nkeine Buchungss\u00e4tze gibt - die Bewegung z\u00e4hlt trotzdem.", "oneOf": [ { "$ref": "#\/components\/schemas\/JournalEntry" } ] }, "reversal_of": { "title": "Die Bewegung, die diese hier storniert.", "description": "Ein echter Verweis und nicht der Buchungstext: der Text ist frei\neditierbar, und eine Stornopr\u00fcfung, die auf \"Storno zu Nr. 4\" sucht,\nlie\u00dfe sich durch Umbenennen aushebeln - und tr\u00e4fe nebenbei auch\n\"Storno zu Nr. 41\".", "oneOf": [ { "$ref": "#\/components\/schemas\/CashTransaction" } ] }, "locked": { "title": "Festgeschrieben - die Bewegung ist unver\u00e4nderlich (GoBD).", "description": "Korrigiert wird wie im Journal \u00fcber eine Gegenbewegung, nicht durch\n\u00c4ndern der urspr\u00fcnglichen Zeile.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ChatbotConsent": { "properties": { "id": { "title": "Primary key of the consent.", "description": "Internal ID.", "type": "integer" }, "granted": { "title": "Whether the consent is granted.", "type": "boolean" }, "text_version": { "title": "Version des Einwilligungstextes (Setting chatbot_member_consent_version).", "type": "string" }, "text_hash": { "title": "sha256 des Textes, dem tatsaechlich zugestimmt wurde.", "type": "string" }, "source": { "title": "customer_app | admin | import - siehe SOURCE_* Konstanten.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ChatbotConsent2": { "properties": { "id": { "title": "Primary key of the consent.", "description": "Internal ID.", "type": "integer" }, "granted": { "title": "Whether the consent is granted.", "type": "boolean" }, "text_version": { "title": "Version des Einwilligungstextes (Setting chatbot_member_consent_version).", "type": "string" }, "text_hash": { "title": "sha256 des Textes, dem tatsaechlich zugestimmt wurde.", "type": "string" }, "source": { "title": "customer_app | admin | import - siehe SOURCE_* Konstanten.", "type": "string" }, "ip_hash": { "title": "sha256 der IP-Adresse - kein Klartext, aber als Nachweis verwertbar.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ChatbotProfile": { "properties": { "id": { "title": "Primary key of the chatbot profile.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the chatbot profile.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the chatbot as hex value.", "type": "string" }, "mode": { "title": "admin | member | public - siehe MODE_* Konstanten.", "description": "Der Modus bestimmt, in welchen Raeumen das Profil ueberhaupt eingesetzt\nwerden darf (Bot-Modus <= Vertrauensstufe des Raums).", "type": "string" }, "system_prompt": { "title": "System-Prompt mit Platzhaltern ([[PERSON_INFO]], [[BASIC_PRINCIPLES]],\n[[ROOM_INFO]], [[TODAY]], [[TOOL_HINTS]], ...).", "type": "string" }, "model": { "title": "Modell-ID in LiteLLM-Notation. Leer heisst: Setting chatbot_default_model.", "type": "string" }, "max_tokens": { "title": "Maximum number of tokens per answer.", "type": "integer" }, "max_tool_iterations": { "title": "Obergrenze Tool-Aufrufe pro Turn. Leer heisst: Setting chatbot_tool_max_iterations.", "type": "integer" }, "max_context_messages": { "title": "Wie viele abgeschlossene Nachrichten als Kontext an das Modell gehen.", "type": "integer" }, "reply_mode": { "title": "always | mention | question - siehe REPLY_MODE_* Konstanten.", "type": "string" }, "requires_opt_in": { "title": "Muss die Person vor der Nutzung einwilligen? Bei mode=member erzwungen true.", "type": "boolean" }, "disclaimer_text": { "title": "Wird beim Beitritt als erste internal_system-Nachricht im Raum gepostet.", "type": "string" }, "active": { "title": "Whether the chatbot profile is active.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "ChatbotProfile3": { "properties": { "id": { "title": "Primary key of the chatbot profile.", "description": "Internal ID.", "type": "integer" }, "preferred_color_hex": { "title": "Preferred color of the chatbot as hex value.", "type": "string" }, "mode": { "title": "admin | member | public - siehe MODE_* Konstanten.", "description": "Der Modus bestimmt, in welchen Raeumen das Profil ueberhaupt eingesetzt\nwerden darf (Bot-Modus <= Vertrauensstufe des Raums).", "type": "string" }, "system_prompt": { "title": "System-Prompt mit Platzhaltern ([[PERSON_INFO]], [[BASIC_PRINCIPLES]],\n[[ROOM_INFO]], [[TODAY]], [[TOOL_HINTS]], ...).", "type": "string" }, "model": { "title": "Modell-ID in LiteLLM-Notation. Leer heisst: Setting chatbot_default_model.", "type": "string" }, "max_tokens": { "title": "Maximum number of tokens per answer.", "type": "integer" }, "max_tool_iterations": { "title": "Obergrenze Tool-Aufrufe pro Turn. Leer heisst: Setting chatbot_tool_max_iterations.", "type": "integer" }, "max_context_messages": { "title": "Wie viele abgeschlossene Nachrichten als Kontext an das Modell gehen.", "type": "integer" }, "reply_mode": { "title": "always | mention | question - siehe REPLY_MODE_* Konstanten.", "type": "string" }, "requires_opt_in": { "title": "Muss die Person vor der Nutzung einwilligen? Bei mode=member erzwungen true.", "type": "boolean" }, "disclaimer_text": { "title": "Wird beim Beitritt als erste internal_system-Nachricht im Raum gepostet.", "type": "string" }, "active": { "title": "Whether the chatbot profile is active.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "ChatbotTurnLog": { "properties": { "id": { "title": "Primary key of the chatbot turn log.", "description": "Internal ID.", "type": "integer" }, "model": { "title": "Language model used for the turn.", "type": "string" }, "prompt_tokens": { "title": "Number of prompt tokens used.", "type": "integer" }, "completion_tokens": { "title": "Number of completion tokens used.", "type": "integer" }, "llm_calls": { "title": "Number of model calls made for the turn.", "type": "integer" }, "tool_calls": { "title": "Anzahl der Tool-Aufrufe - die Einzelheiten stehen in ai_meta an der\nNachricht, hier zaehlt nur die Menge.", "type": "integer" }, "duration_ms": { "title": "Duration of the turn in milliseconds.", "type": "integer" }, "finish_reason": { "title": "stop | max_iterations | timeout | error - so, wie der Dienst es meldet.", "type": "string" }, "status": { "title": "ok | error | skipped - siehe STATUS_* Konstanten.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "Chatroom": { "properties": { "unread_count": { "type": "integer" }, "is_unread": { "type": "boolean" }, "member_managed": { "title": "Event- und freie Gruppenraeume verwalten Mitglieder bzw. Raum-Admins mit\n(verlassen, aufnehmen); Support-, Assistenten- und Fragebogen-Raeume nur\ndie Verwaltung. Die Apps blenden danach die Raum-Optionen ein.", "type": "boolean" }, "is_support_room": { "title": "Ist das der Haushalts-Chat mit dem Verein (Support-Chat)? Die Kunden-Apps sehen die Firma\nnicht und zeigen damit den Hinweis auf die Buerozeiten (chatroom_support_office_hours_enabled).", "type": "boolean" }, "id": { "title": "Primary key of the chat room.", "description": "Internal ID.", "type": "integer" }, "notification_token": { "title": "Token used for notifications of the chat room.", "type": "string" }, "trust_level": { "title": "Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen;\ngesetzt wird sie ausschliesslich vom ChatroomTrustLevelHelper.", "type": "string" }, "member_started_type": { "title": "Von Mitgliedern gestartet (Paket D): \"direct\" (1:1, chatroom_member_direct_enabled) oder\n\"group\" (Gruppe eines Trainers, chatroom_trainer_groups_enabled); null fuer alle anderen Raeume.", "type": "string" }, "handover_at": { "title": "Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das\ngesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das\nTeam. Gesetzt und geloescht nur vom ChatbotHandoverHelper.", "type": "string", "format": "date-time" }, "handover_reason": { "title": "Siehe HANDOVER_REASON_*.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "Chatroom10": { "properties": { "id": { "title": "Primary key of the chat room.", "description": "Internal ID.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "Chatroom2": { "properties": { "unread_count": { "type": "integer" }, "is_unread": { "type": "boolean" }, "member_managed": { "title": "Event- und freie Gruppenraeume verwalten Mitglieder bzw. Raum-Admins mit\n(verlassen, aufnehmen); Support-, Assistenten- und Fragebogen-Raeume nur\ndie Verwaltung. Die Apps blenden danach die Raum-Optionen ein.", "type": "boolean" }, "id": { "title": "Primary key of the chat room.", "description": "Internal ID.", "type": "integer" }, "notification_token": { "title": "Token used for notifications of the chat room.", "type": "string" }, "trust_level": { "title": "Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen;\ngesetzt wird sie ausschliesslich vom ChatroomTrustLevelHelper.", "type": "string" }, "member_started_type": { "title": "Von Mitgliedern gestartet (Paket D): \"direct\" (1:1, chatroom_member_direct_enabled) oder\n\"group\" (Gruppe eines Trainers, chatroom_trainer_groups_enabled); null fuer alle anderen Raeume.", "type": "string" }, "handover_at": { "title": "Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das\ngesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das\nTeam. Gesetzt und geloescht nur vom ChatbotHandoverHelper.", "type": "string", "format": "date-time" }, "handover_reason": { "title": "Siehe HANDOVER_REASON_*.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "Chatroom3": { "properties": { "unread_count": { "type": "integer" }, "is_unread": { "type": "boolean" }, "chatbot_active": { "title": "Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung:\ndort kann das Team den Raum dann uebernehmen.", "type": "boolean" }, "member_managed": { "title": "Event- und freie Gruppenraeume verwalten Mitglieder bzw. Raum-Admins mit\n(verlassen, aufnehmen); Support-, Assistenten- und Fragebogen-Raeume nur\ndie Verwaltung. Die Apps blenden danach die Raum-Optionen ein.", "type": "boolean" }, "support_status": { "title": "Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.", "type": "string" }, "id": { "title": "Primary key of the chat room.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the chat room.", "type": "string" }, "notification_token": { "title": "Token used for notifications of the chat room.", "type": "string" }, "last_read_at": { "title": "A timestamp of the last time a admin participant read the chatroom", "type": "string", "format": "date-time" }, "message_count_read": { "title": "Number of messages read.", "type": "integer" }, "trust_level": { "title": "Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen;\ngesetzt wird sie ausschliesslich vom ChatroomTrustLevelHelper.", "type": "string" }, "member_started_type": { "title": "Von Mitgliedern gestartet (Paket D): \"direct\" (1:1, chatroom_member_direct_enabled) oder\n\"group\" (Gruppe eines Trainers, chatroom_trainer_groups_enabled); null fuer alle anderen Raeume.", "type": "string" }, "handover_at": { "title": "Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das\ngesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das\nTeam. Gesetzt und geloescht nur vom ChatbotHandoverHelper.", "type": "string", "format": "date-time" }, "handover_reason": { "title": "Siehe HANDOVER_REASON_*.", "type": "string" }, "support_snoozed_until": { "title": "Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "Chatroom4": { "properties": { "unread_count": { "type": "integer" }, "is_unread": { "type": "boolean" }, "chatbot_active": { "title": "Antwortet hier gerade die KI? Fuer den Support-Modus der Verwaltung:\ndort kann das Team den Raum dann uebernehmen.", "type": "boolean" }, "member_managed": { "title": "Event- und freie Gruppenraeume verwalten Mitglieder bzw. Raum-Admins mit\n(verlassen, aufnehmen); Support-, Assistenten- und Fragebogen-Raeume nur\ndie Verwaltung. Die Apps blenden danach die Raum-Optionen ein.", "type": "boolean" }, "is_support_room": { "title": "Ist das der Haushalts-Chat mit dem Verein (Support-Chat)? Die Kunden-Apps sehen die Firma\nnicht und zeigen damit den Hinweis auf die Buerozeiten (chatroom_support_office_hours_enabled).", "type": "boolean" }, "support_status": { "title": "Der Status, wie die Inbox ihn zeigt: ein abgelaufenes Zurueckstellen zaehlt als offen.", "type": "string" }, "id": { "title": "Primary key of the chat room.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the chat room.", "type": "string" }, "notification_token": { "title": "Token used for notifications of the chat room.", "type": "string" }, "participants": { "title": "Participants of the chat room.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatroomParticipant4" } }, "last_read_at": { "title": "A timestamp of the last time a admin participant read the chatroom", "type": "string", "format": "date-time" }, "message_count_read": { "title": "Number of messages read.", "type": "integer" }, "trust_level": { "title": "Berechnete Vertrauensstufe, siehe TRUST_LEVEL_*. Nur lesend nach aussen;\ngesetzt wird sie ausschliesslich vom ChatroomTrustLevelHelper.", "type": "string" }, "member_started_type": { "title": "Von Mitgliedern gestartet (Paket D): \"direct\" (1:1, chatroom_member_direct_enabled) oder\n\"group\" (Gruppe eines Trainers, chatroom_trainer_groups_enabled); null fuer alle anderen Raeume.", "type": "string" }, "handover_at": { "title": "Seit wann die KI sich aus dem Raum zurueckgezogen hat. Solange das\ngesetzt ist, antwortet kein Profil-Bot mehr; der Raum wartet auf das\nTeam. Gesetzt und geloescht nur vom ChatbotHandoverHelper.", "type": "string", "format": "date-time" }, "handover_reason": { "title": "Siehe HANDOVER_REASON_*.", "type": "string" }, "support_snoozed_until": { "title": "Zurueckgestellt bis; danach zaehlt der Raum wieder als offen.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "ChatroomMessage": { "properties": { "id": { "title": "Primary key of the chat message.", "description": "Internal ID.", "type": "integer" }, "message_text": { "title": "Text of the chat message.", "type": "string" }, "attachments": { "title": "Attachments of the chat message.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment2" } }, "reactions": { "title": "Reactions to the chat message.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction4" } }, "completed": { "title": "A flag to indicate if this message is completed", "type": "boolean" }, "edited_at": { "title": "Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ChatroomMessage2": { "properties": { "id": { "title": "Primary key of the chat message.", "description": "Internal ID.", "type": "integer" }, "participant": { "title": "Participant who wrote the message.", "oneOf": [ { "$ref": "#\/components\/schemas\/ChatroomParticipant5" } ] }, "message_text": { "title": "Text of the chat message.", "type": "string" }, "attachments": { "title": "Attachments of the chat message.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment22" } }, "reactions": { "title": "Reactions to the chat message.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction2" } }, "completed": { "title": "A flag to indicate if this message is completed", "type": "boolean" }, "edited_at": { "title": "Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "ChatroomMessage3": { "properties": { "id": { "title": "Primary key of the chat message.", "description": "Internal ID.", "type": "integer" }, "chatroom": { "title": "Chat room the message belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Chatroom10" } ] }, "participant": { "title": "Participant who wrote the message.", "oneOf": [ { "$ref": "#\/components\/schemas\/ChatroomParticipant5" } ] }, "message_text": { "title": "Text of the chat message.", "type": "string" }, "attachments": { "title": "Attachments of the chat message.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment22" } }, "reactions": { "title": "Reactions to the chat message.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ChatroomMessageReaction6" } }, "completed": { "title": "A flag to indicate if this message is completed", "type": "boolean" }, "edited_at": { "title": "Wann der Text zuletzt bearbeitet wurde (Einstellung chatroom_message_edit_enabled).", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "ChatroomMessage4": { "properties": { "id": { "title": "Primary key of the chat message.", "description": "Internal ID.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "ChatroomMessageReaction": { "properties": { "id": { "title": "Primary key of the reaction.", "description": "Internal ID.", "type": "integer" }, "emoji": { "title": "Emoji of the reaction.", "type": "string" } }, "type": "object" }, "ChatroomMessageReaction2": { "properties": { "id": { "title": "Primary key of the reaction.", "description": "Internal ID.", "type": "integer" }, "emoji": { "title": "Emoji of the reaction.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "ChatroomMessageReaction3": { "properties": { "id": { "title": "Primary key of the reaction.", "description": "Internal ID.", "type": "integer" }, "emoji": { "title": "Emoji of the reaction.", "type": "string" }, "chatroom": { "title": "Chat room the reaction belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Chatroom10" } ] }, "message": { "title": "Chat message that was reacted to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ChatroomMessage4" } ] }, "participant": { "title": "Participant who reacted.", "oneOf": [ { "$ref": "#\/components\/schemas\/ChatroomParticipant5" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "ChatroomMessageReaction4": { "properties": { "id": { "title": "Primary key of the reaction.", "description": "Internal ID.", "type": "integer" }, "emoji": { "title": "Emoji of the reaction.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ChatroomMessageReaction6": { "properties": { "id": { "title": "Primary key of the reaction.", "description": "Internal ID.", "type": "integer" }, "emoji": { "title": "Emoji of the reaction.", "type": "string" }, "participant": { "title": "Participant who reacted.", "oneOf": [ { "$ref": "#\/components\/schemas\/ChatroomParticipant5" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "ChatroomParticipant": { "properties": { "id": { "title": "Primary key of the participant.", "description": "Internal ID.", "type": "integer" }, "participant_type": { "title": "Type of the participant.", "type": "string" }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "nickname": { "title": "Nickname of the participant.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the participant as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "room_admin": { "title": "A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants", "type": "boolean" }, "can_write": { "title": "A flag to indicate if this participant can write messages", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "ChatroomParticipant2": { "properties": { "id": { "title": "Primary key of the participant.", "description": "Internal ID.", "type": "integer" }, "participant_type": { "title": "Type of the participant.", "type": "string" }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "nickname": { "title": "Nickname of the participant.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the participant as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "last_read_at": { "title": "A timestamp of the last time this participant read the chatroom", "type": "string", "format": "date-time" }, "message_count_read": { "title": "Number of messages read by the participant.", "type": "integer" }, "room_admin": { "title": "A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants", "type": "boolean" }, "can_write": { "title": "A flag to indicate if this participant can write messages", "type": "boolean" }, "is_muted": { "title": "A flag to indicate if this participant wants to receive notifications", "type": "boolean" }, "messenger_channel": { "title": "sms | whatsapp - set for an external participant who writes to the support over SMS or\nWhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).", "type": "string" }, "messenger_phone_number": { "title": "Mobile number of the messenger participant, E.164 digits without +.", "type": "string" }, "messenger_verified_at": { "title": "Point in time the messenger was verified.", "type": "string", "format": "date-time" }, "left_at": { "title": "Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt\nwurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.", "type": "string", "format": "date-time" }, "left_reason": { "title": "self | room_admin, siehe LEFT_REASON_*", "type": "string" }, "notify_level": { "title": "Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none,\nsiehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted\nentscheidet (alt, von der Verwaltung gesetzt), sonst alle.", "type": "string" }, "muted_until": { "title": "Bis wann der Raum ganz stumm ist (\"fuer 8 Stunden aus\"), danach gilt wieder notify_level.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "ChatroomParticipant3": { "properties": { "id": { "title": "Primary key of the participant.", "description": "Internal ID.", "type": "integer" }, "participant_type": { "title": "Type of the participant.", "type": "string" }, "chatroom": { "title": "Chat room the participant belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Chatroom10" } ] }, "public_session": { "title": "Public session of the participant.", "oneOf": [ { "$ref": "#\/components\/schemas\/PublicSession4" } ] }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "nickname": { "title": "Nickname of the participant.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the participant as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "last_read_at": { "title": "A timestamp of the last time this participant read the chatroom", "type": "string", "format": "date-time" }, "message_count_read": { "title": "Number of messages read by the participant.", "type": "integer" }, "room_admin": { "title": "A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants", "type": "boolean" }, "can_write": { "title": "A flag to indicate if this participant can write messages", "type": "boolean" }, "is_muted": { "title": "A flag to indicate if this participant wants to receive notifications", "type": "boolean" }, "auto_created": { "title": "A flag to indicate if this participant was auto created by being in a company or event", "type": "boolean" }, "reply_mode": { "title": "Override zum Antwortmodus des Profils: always | mention | question.", "description": "Leer heisst: der Wert aus dem Profil gilt.", "type": "string" }, "ai_auto_close_secret_word": { "title": "A word as the last part of an ai reply that will close the chatroom. Used for AI bots.", "type": "string" }, "ai_prompt": { "title": "The system prompt for the AI bot. Used for AI bots.", "type": "string" }, "ai_number_of_context_messages": { "title": "The number of messages we add to the context of the AI bot. Used for AI bots.", "type": "integer" }, "messenger_channel": { "title": "sms | whatsapp - set for an external participant who writes to the support over SMS or\nWhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).", "type": "string" }, "messenger_phone_number": { "title": "Mobile number of the messenger participant, E.164 digits without +.", "type": "string" }, "messenger_verified_at": { "title": "Point in time the messenger was verified.", "type": "string", "format": "date-time" }, "left_at": { "title": "Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt\nwurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.", "type": "string", "format": "date-time" }, "left_reason": { "title": "self | room_admin, siehe LEFT_REASON_*", "type": "string" }, "notify_level": { "title": "Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none,\nsiehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted\nentscheidet (alt, von der Verwaltung gesetzt), sonst alle.", "type": "string" }, "muted_until": { "title": "Bis wann der Raum ganz stumm ist (\"fuer 8 Stunden aus\"), danach gilt wieder notify_level.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "ChatroomParticipant4": { "properties": { "id": { "title": "Primary key of the participant.", "description": "Internal ID.", "type": "integer" }, "participant_type": { "title": "Type of the participant.", "type": "string" }, "public_session": { "title": "Public session of the participant.", "oneOf": [ { "$ref": "#\/components\/schemas\/PublicSession4" } ] }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "nickname": { "title": "Nickname of the participant.", "type": "string" }, "preferred_color_hex": { "title": "Preferred color of the participant as hex value.", "type": "string" }, "avatar_token": { "title": "Token of the avatar image.", "type": "string" }, "last_read_at": { "title": "A timestamp of the last time this participant read the chatroom", "type": "string", "format": "date-time" }, "message_count_read": { "title": "Number of messages read by the participant.", "type": "integer" }, "room_admin": { "title": "A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants", "type": "boolean" }, "can_write": { "title": "A flag to indicate if this participant can write messages", "type": "boolean" }, "is_muted": { "title": "A flag to indicate if this participant wants to receive notifications", "type": "boolean" }, "auto_created": { "title": "A flag to indicate if this participant was auto created by being in a company or event", "type": "boolean" }, "reply_mode": { "title": "Override zum Antwortmodus des Profils: always | mention | question.", "description": "Leer heisst: der Wert aus dem Profil gilt.", "type": "string" }, "ai_auto_close_secret_word": { "title": "A word as the last part of an ai reply that will close the chatroom. Used for AI bots.", "type": "string" }, "ai_prompt": { "title": "The system prompt for the AI bot. Used for AI bots.", "type": "string" }, "ai_number_of_context_messages": { "title": "The number of messages we add to the context of the AI bot. Used for AI bots.", "type": "integer" }, "messenger_channel": { "title": "sms | whatsapp - set for an external participant who writes to the support over SMS or\nWhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).", "type": "string" }, "messenger_phone_number": { "title": "Mobile number of the messenger participant, E.164 digits without +.", "type": "string" }, "messenger_verified_at": { "title": "Point in time the messenger was verified.", "type": "string", "format": "date-time" }, "left_at": { "title": "Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt\nwurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.", "type": "string", "format": "date-time" }, "left_reason": { "title": "self | room_admin, siehe LEFT_REASON_*", "type": "string" }, "notify_level": { "title": "Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none,\nsiehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted\nentscheidet (alt, von der Verwaltung gesetzt), sonst alle.", "type": "string" }, "muted_until": { "title": "Bis wann der Raum ganz stumm ist (\"fuer 8 Stunden aus\"), danach gilt wieder notify_level.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "ChatroomParticipant5": { "properties": { "id": { "title": "Primary key of the participant.", "description": "Internal ID.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "Collection": { "type": "object" }, "ContactDataType": { "properties": { "id": { "title": "Primary key of the contact data type.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the contact data type, for example phone or e-mail.", "type": "string" }, "value": { "title": "Value of the contact data type.", "type": "string" }, "allow_self_service": { "title": "Members may edit this contact data type in self-service.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "CookieConfig": { "properties": { "id": { "title": "Primary key of the configuration.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "Whether the banner is shown.", "type": "boolean" }, "version_two": { "title": "Whether the second version of the banner is used.", "type": "boolean" }, "fontcolor": { "title": "Font color of the banner.", "type": "string" }, "backgroundcolor": { "title": "Background color of the banner.", "type": "string" }, "popup_link_color": { "title": "Color of the links in the banner.", "type": "string" }, "cookiemessage": { "title": "Text of the cookie message.", "type": "string" }, "only_cookie_message": { "title": "Whether only the cookie message is shown, without the consent dialog.", "type": "boolean" }, "link_title_one": { "title": "Title of the first link in the banner.", "type": "string" }, "link_href_one": { "title": "Target of the first link in the banner.", "type": "string" }, "link_title_two": { "title": "Title of the second link in the banner.", "type": "string" }, "link_href_two": { "title": "Target of the second link in the banner.", "type": "string" }, "content_header": { "title": "Header of the consent dialog.", "type": "string" }, "content_question": { "title": "Question shown in the consent dialog.", "type": "string" }, "content_allow": { "title": "Label of the button that allows cookies.", "type": "string" }, "content_deny": { "title": "Label of the button that denies cookies.", "type": "string" }, "img_title": { "title": "Title of the image shown in the banner.", "type": "string" }, "img_src": { "title": "Source URL of the image shown in the banner.", "type": "string" }, "modify_body_padding": { "title": "Whether the banner adds padding to the page body.", "type": "boolean" }, "position": { "title": "Position of the banner on the page.", "type": "string" }, "fallback_position": { "title": "Fallback position of the banner.", "type": "string" }, "buttoncolor": { "title": "Background color of the buttons.", "type": "string" }, "buttonfontcolor": { "title": "Font color of the buttons.", "type": "string" }, "btn_a_border_color": { "title": "Border color of button A.", "type": "string" }, "btn_a_bg_hov_color": { "title": "Background color of button A on hover.", "type": "string" }, "btn_a_border_hov_color": { "title": "Border color of button A on hover.", "type": "string" }, "btn_a_font_hov_color": { "title": "Font color of button A on hover.", "type": "string" }, "btn_d_bg_color": { "title": "Background color of button D.", "type": "string" }, "btn_d_border_color": { "title": "Border color of button D.", "type": "string" }, "btn_d_font_color": { "title": "Font color of button D.", "type": "string" }, "btn_d_bg_hov_color": { "title": "Background color of button D on hover.", "type": "string" }, "btn_d_border_hov_color": { "title": "Border color of button D on hover.", "type": "string" }, "btn_d_font_hov_color": { "title": "Font color of button D on hover.", "type": "string" }, "overlay_bg_color": { "title": "Background color of the overlay behind the banner.", "type": "string" } }, "type": "object" }, "CostCenter": { "properties": { "display_name": { "type": "string" }, "id": { "title": "Primary key of the cost center.", "description": "Internal ID.", "type": "integer" }, "number": { "title": "Number of the cost center.", "type": "string" }, "sphere": { "title": "Steuerliche Sph\u00e4re, null bei rein betriebswirtschaftlicher Gliederung.", "type": "string" }, "is_system": { "title": "The cost center is created by the system and cannot be deleted.", "type": "boolean" }, "is_active": { "title": "The cost center is active.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CrmPersonSendNotification": { "properties": { "id": { "title": "Primary key of the notification.", "description": "Internal ID.", "type": "integer" }, "membership_entry_notification_sent": { "title": "When the membership entry notification (Eintritt) was last sent", "type": "string", "format": "date-time" }, "membership_exit_notification_sent": { "title": "When the membership exit notification (Austritt) was last sent", "type": "string", "format": "date-time" }, "birthday_greeting_sent": { "title": "When the birthday greeting was last sent", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CrmPersonSendNotification2": { "properties": { "id": { "title": "Primary key of the notification.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the notification is sent to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "membership_entry_notification_sent": { "title": "When the membership entry notification (Eintritt) was last sent", "type": "string", "format": "date-time" }, "membership_exit_notification_sent": { "title": "When the membership exit notification (Austritt) was last sent", "type": "string", "format": "date-time" }, "birthday_greeting_sent": { "title": "When the birthday greeting was last sent", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CronTask": { "properties": { "name": { "title": "Name of the cron task.", "type": "string" }, "command": { "title": "Command the cron task runs.", "type": "string" }, "result": { "title": "Result of the last run.", "type": "string" }, "interval_length": { "title": "Interval between two runs.", "type": "string" }, "last_run": { "title": "Point in time of the last run.", "type": "string", "format": "date-time" }, "next_run": { "title": "Point in time of the next run.", "type": "string", "format": "date-time" }, "running": { "title": "Whether the task is currently running.", "type": "boolean" }, "done": { "title": "Whether the task is done.", "type": "boolean" }, "delete_after_done": { "title": "Whether the task is deleted after it is done.", "type": "boolean" } }, "type": "object" }, "CustomerAppHomeWidgetDefault": { "properties": { "id": { "title": "Primary key of the default widget.", "description": "Internal ID.", "type": "integer" }, "widget_type": { "title": "Type of the widget.", "type": "string" }, "title": { "title": "Title of the widget.", "type": "string" }, "grid_x": { "title": "Column of the widget in the grid.", "type": "integer" }, "grid_y": { "title": "Row of the widget in the grid.", "type": "integer" }, "span_x": { "title": "Number of columns the widget spans.", "type": "integer" }, "span_y": { "title": "Number of rows the widget spans.", "type": "integer" }, "widget_config": { "title": "Configuration of the widget, stored as JSON.", "type": "string" }, "sort_order": { "title": "Position of the widget in the list.", "type": "integer" }, "scope": { "title": "Scope the default widget applies to.", "type": "string" }, "available": { "title": "Whether the widget can be selected.", "type": "boolean" }, "default_widget": { "title": "Whether the widget is shown by default.", "type": "boolean" }, "enabled": { "title": "Whether the widget is enabled.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerAppMenuGroup": { "properties": { "id": { "title": "Primary key of the menu group.", "description": "Internal ID.", "type": "integer" }, "group_key": { "title": "Unique key of the menu group.", "type": "string" }, "title": { "title": "Title of the menu group shown in the app.", "type": "string" }, "sort_order": { "title": "Position of the group in the menu.", "type": "integer" }, "visibility_rule": { "title": "Rule that decides when the group is visible.", "type": "string" }, "menu_items": { "title": "Menu items in the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CustomerAppMenuItem2" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerAppMenuGroup2": { "properties": { "id": { "title": "Primary key of the menu group.", "description": "Internal ID.", "type": "integer" }, "group_key": { "title": "Unique key of the menu group.", "type": "string" }, "title": { "title": "Title of the menu group shown in the app.", "type": "string" }, "sort_order": { "title": "Position of the group in the menu.", "type": "integer" }, "visibility_rule": { "title": "Rule that decides when the group is visible.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerAppMenuItem": { "properties": { "id": { "title": "Primary key of the menu item.", "description": "Internal ID.", "type": "integer" }, "item_key": { "title": "Unique key of the menu item.", "type": "string" }, "enabled": { "title": "Whether the menu item is shown in the app.", "type": "boolean" }, "title": { "title": "Title of the menu item shown in the app.", "type": "string" }, "icon": { "title": "Icon of the menu item.", "type": "string" }, "route": { "title": "Route the menu item opens.", "type": "string" }, "item_type": { "title": "Type of the menu item.", "type": "string" }, "menu_group": { "title": "Menu group the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomerAppMenuGroup2" } ] }, "sort_order": { "title": "Position of the item in the menu.", "type": "integer" }, "tab_bar_enabled": { "title": "Whether the item is shown in the tab bar.", "type": "boolean" }, "tab_bar_priority": { "title": "Priority of the item in the tab bar.", "type": "integer" }, "visibility_rule": { "title": "Rule that decides when the item is visible.", "type": "string" }, "server_constraints": { "title": "Server-side constraints as JSON array.", "description": "Example: [{\"type\": \"app_config\", \"key\": \"C_APP_ENABLE_FUNCTION_NEWS\"}]", "type": "string" }, "client_constraints": { "title": "Client-side constraint tags as JSON array.", "description": "Example: [{\"type\": \"platform\", \"value\": \"web\"}]", "type": "string" }, "min_build_id": { "title": "Lowest app build the item is shown for.", "type": "integer" }, "max_build_id": { "title": "Highest app build the item is shown for.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerAppMenuItem2": { "properties": { "id": { "title": "Primary key of the menu item.", "description": "Internal ID.", "type": "integer" }, "item_key": { "title": "Unique key of the menu item.", "type": "string" }, "enabled": { "title": "Whether the menu item is shown in the app.", "type": "boolean" }, "title": { "title": "Title of the menu item shown in the app.", "type": "string" }, "icon": { "title": "Icon of the menu item.", "type": "string" }, "route": { "title": "Route the menu item opens.", "type": "string" }, "item_type": { "title": "Type of the menu item.", "type": "string" }, "sort_order": { "title": "Position of the item in the menu.", "type": "integer" }, "tab_bar_enabled": { "title": "Whether the item is shown in the tab bar.", "type": "boolean" }, "tab_bar_priority": { "title": "Priority of the item in the tab bar.", "type": "integer" }, "visibility_rule": { "title": "Rule that decides when the item is visible.", "type": "string" }, "server_constraints": { "title": "Server-side constraints as JSON array.", "description": "Example: [{\"type\": \"app_config\", \"key\": \"C_APP_ENABLE_FUNCTION_NEWS\"}]", "type": "string" }, "client_constraints": { "title": "Client-side constraint tags as JSON array.", "description": "Example: [{\"type\": \"platform\", \"value\": \"web\"}]", "type": "string" }, "min_build_id": { "title": "Lowest app build the item is shown for.", "type": "integer" }, "max_build_id": { "title": "Highest app build the item is shown for.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerMessage": { "properties": { "id": { "title": "Primary key of the customer message.", "description": "Internal ID.", "type": "integer" }, "username": { "title": "User name of the author.", "type": "string" }, "displayname": { "title": "Name shown for the author.", "type": "string" }, "userposition": { "title": "Position of the author shown with the message.", "type": "string" }, "profile_picture_url": { "title": "URL of the profile picture of the author.", "type": "string" }, "text": { "title": "Text of the message.", "type": "string" }, "attachments": { "title": "Attachments of the message.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerProfile": { "properties": { "id": { "title": "Primary key of the customer profile.", "description": "Internal ID.", "type": "integer" }, "slackchannel": { "title": "Slack channel of the customer profile.", "type": "string" }, "displayname": { "title": "Name shown for the customer profile.", "type": "string" }, "deleted": { "title": "Whether the customer profile is deleted.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerTicket": { "properties": { "satisfaction_requested_at": { "title": "When the customer \/ member was asked to rate the finished ticket; the apps offer the rating\nonce this is set.", "type": "string" }, "id": { "title": "Primary key of the ticket.", "description": "Internal ID.", "type": "integer" }, "ticket_type": { "title": "Type of the ticket.", "type": "string" }, "number": { "title": "Running ticket number.", "type": "integer" }, "number_string": { "title": "Ticket number as displayed to users.", "type": "string" }, "company": { "title": "Company the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "person": { "title": "Person the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "jirakey": { "title": "Key of the linked Jira issue.", "type": "string" }, "jiraid": { "title": "ID of the linked Jira issue.", "type": "string" }, "assignedusername": { "title": "Name of the assigned user, as text.", "type": "string" }, "assigned_user": { "title": "User the ticket is assigned to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "createdbyusername": { "title": "Name of the user who created the ticket, as text.", "type": "string" }, "created_by_user": { "title": "User who created the ticket.", "oneOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "status": { "title": "Status of the ticket as text.", "type": "string" }, "statusid": { "title": "ID of the status of the ticket.", "type": "string" }, "issuetype": { "title": "A type like bug, task, story", "type": "string" }, "issuecategory": { "title": "A category like website, hosting, marketing", "type": "string" }, "crm_project_category_area": { "title": "Project category area the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategoryArea" } ] }, "issueproject": { "title": "A project like a domain (inwendo.de) or a certain mail campaign", "type": "string" }, "crm_project": { "title": "CRM project the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject8" } ] }, "crm_project_item": { "title": "CRM project item the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem4" } ] }, "sprint": { "title": "The sprint this ticket is planned for. Tickets without a sprint are the backlog.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMSprint" } ] }, "board_order": { "title": "Manual position of the ticket inside its kanban column \/ sprint backlog", "type": "integer" }, "story_points": { "title": "Relative planning estimate used during sprint planning", "type": "integer" }, "duedate": { "title": "Due date of the ticket.", "type": "string", "format": "date-time" }, "preferred_due_date": { "title": "Due date preferred by the customer.", "type": "string", "format": "date-time" }, "customer_start_date": { "title": "Start date requested by the customer.", "type": "string", "format": "date-time" }, "customer_end_date": { "title": "End date requested by the customer.", "type": "string", "format": "date-time" }, "reopen_date": { "title": "Date on which the ticket is reopened.", "type": "string", "format": "date-time" }, "work_time_till_due_date_in_seconds": { "title": "Working time until the due date, in seconds.", "type": "integer" }, "timeestimate": { "title": "Time estimate as text.", "type": "string" }, "estimated_time_in_seconds": { "title": "Estimated time in seconds.", "type": "integer" }, "estimated_time_in_hours": { "title": "Estimated time in hours.", "type": "number", "format": "float" }, "confirmed_time_in_seconds": { "title": "Time confirmed for the ticket, in seconds.", "type": "integer" }, "priority": { "title": "Priority of the ticket.", "type": "integer" }, "business_value": { "title": "Business value of the ticket, used for scoring.", "type": "integer" }, "calculated_score": { "title": "Calculated priority score of the ticket.", "type": "number", "format": "float" }, "calculated_score_business_value": { "title": "Part of the calculated score that comes from the business value.", "type": "number", "format": "float" }, "calculated_score_due_date": { "title": "Part of the calculated score that comes from the due date.", "type": "number", "format": "float" }, "ai_urgency_score": { "title": "Interner Dringlichkeits-Score 0-100 aus der KI-Triage (TicketAiTriageHelper),\nnull = nicht bewertet. Nur fuer das Team sichtbar.", "type": "integer" }, "ai_emergency": { "title": "Die KI-Triage hat das Ticket als absoluten Notfall erkannt (das Team wurde\nzusaetzlich benachrichtigt). null = nicht geprueft.", "type": "boolean" }, "inportal": { "title": "Whether the ticket is visible in the customer portal.", "type": "boolean" }, "attachments": { "title": "Attachments of the ticket.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "archived": { "title": "Whether the ticket is archived.", "type": "boolean" }, "object_category": { "title": "Category of the object the ticket refers to.", "type": "string" }, "object_identifier": { "title": "Identifier of the object the ticket refers to.", "type": "string" }, "external_person_first_name": { "title": "First name of the external person who reported the ticket.", "type": "string" }, "external_person_last_name": { "title": "Last name of the external person who reported the ticket.", "type": "string" }, "external_person_email": { "title": "E-mail address of the external person who reported the ticket.", "type": "string" }, "external_person_phone": { "title": "Phone number of the external person who reported the ticket.", "type": "string" }, "external_person_address": { "title": "Address of the external person, as text.", "type": "string" }, "external_person_address_street_level": { "title": "Street of the external person's address.", "type": "string" }, "external_person_address_co": { "title": "Care-of line of the external person's address.", "type": "string" }, "external_person_address_city": { "title": "City of the external person's address.", "type": "string" }, "external_person_address_zip": { "title": "Postal code of the external person's address.", "type": "string" }, "external_person_address_country": { "title": "Country of the external person's address.", "type": "string" }, "external_person_birthday": { "title": "Birthday of the external person.", "type": "string", "format": "date-time" }, "external_person_gender": { "title": "Gender of the external person.", "type": "string" }, "external_company_name": { "title": "Name of the external company that reported the ticket.", "type": "string" }, "external_company_email": { "title": "E-mail address of the external company.", "type": "string" }, "external_company_phone": { "title": "Phone number of the external company.", "type": "string" }, "external_company_address": { "title": "Address of the external company, as text.", "type": "string" }, "external_company_address_street_level": { "title": "Street of the external company's address.", "type": "string" }, "external_company_address_co": { "title": "Care-of line of the external company's address.", "type": "string" }, "external_company_address_city": { "title": "City of the external company's address.", "type": "string" }, "external_company_address_zip": { "title": "Postal code of the external company's address.", "type": "string" }, "external_company_address_country": { "title": "Country of the external company's address.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerTicket2": { "properties": { "unified_category": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "type": "object" }, "CustomerTicket3": { "properties": { "satisfaction_requested_at": { "title": "When the customer \/ member was asked to rate the finished ticket; the apps offer the rating\nonce this is set.", "type": "string" }, "id": { "title": "Primary key of the ticket.", "description": "Internal ID.", "type": "integer" }, "ticket_type": { "title": "Type of the ticket.", "type": "string" }, "number": { "title": "Running ticket number.", "type": "integer" }, "number_string": { "title": "Ticket number as displayed to users.", "type": "string" }, "company": { "title": "Company the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany19" } ] }, "person": { "title": "Person the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "jirakey": { "title": "Key of the linked Jira issue.", "type": "string" }, "jiraid": { "title": "ID of the linked Jira issue.", "type": "string" }, "assignedusername": { "title": "Name of the assigned user, as text.", "type": "string" }, "assigned_user": { "title": "User the ticket is assigned to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "createdbyusername": { "title": "Name of the user who created the ticket, as text.", "type": "string" }, "created_by_user": { "title": "User who created the ticket.", "oneOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "status": { "title": "Status of the ticket as text.", "type": "string" }, "statusid": { "title": "ID of the status of the ticket.", "type": "string" }, "issuetype": { "title": "A type like bug, task, story", "type": "string" }, "issuecategory": { "title": "A category like website, hosting, marketing", "type": "string" }, "crm_project_category_area": { "title": "Project category area the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategoryArea" } ] }, "issueproject": { "title": "A project like a domain (inwendo.de) or a certain mail campaign", "type": "string" }, "crm_project": { "title": "CRM project the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject9" } ] }, "crm_project_item": { "title": "CRM project item the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem5" } ] }, "sprint": { "title": "The sprint this ticket is planned for. Tickets without a sprint are the backlog.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMSprint" } ] }, "board_order": { "title": "Manual position of the ticket inside its kanban column \/ sprint backlog", "type": "integer" }, "story_points": { "title": "Relative planning estimate used during sprint planning", "type": "integer" }, "duedate": { "title": "Due date of the ticket.", "type": "string", "format": "date-time" }, "preferred_due_date": { "title": "Due date preferred by the customer.", "type": "string", "format": "date-time" }, "customer_start_date": { "title": "Start date requested by the customer.", "type": "string", "format": "date-time" }, "customer_end_date": { "title": "End date requested by the customer.", "type": "string", "format": "date-time" }, "reopen_date": { "title": "Date on which the ticket is reopened.", "type": "string", "format": "date-time" }, "work_time_till_due_date_in_seconds": { "title": "Working time until the due date, in seconds.", "type": "integer" }, "timeestimate": { "title": "Time estimate as text.", "type": "string" }, "estimated_time_in_seconds": { "title": "Estimated time in seconds.", "type": "integer" }, "estimated_time_in_hours": { "title": "Estimated time in hours.", "type": "number", "format": "float" }, "confirmed_time_in_seconds": { "title": "Time confirmed for the ticket, in seconds.", "type": "integer" }, "priority": { "title": "Priority of the ticket.", "type": "integer" }, "business_value": { "title": "Business value of the ticket, used for scoring.", "type": "integer" }, "calculated_score": { "title": "Calculated priority score of the ticket.", "type": "number", "format": "float" }, "calculated_score_business_value": { "title": "Part of the calculated score that comes from the business value.", "type": "number", "format": "float" }, "calculated_score_due_date": { "title": "Part of the calculated score that comes from the due date.", "type": "number", "format": "float" }, "ai_urgency_score": { "title": "Interner Dringlichkeits-Score 0-100 aus der KI-Triage (TicketAiTriageHelper),\nnull = nicht bewertet. Nur fuer das Team sichtbar.", "type": "integer" }, "ai_emergency": { "title": "Die KI-Triage hat das Ticket als absoluten Notfall erkannt (das Team wurde\nzusaetzlich benachrichtigt). null = nicht geprueft.", "type": "boolean" }, "inportal": { "title": "Whether the ticket is visible in the customer portal.", "type": "boolean" }, "attachments": { "title": "Attachments of the ticket.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "archived": { "title": "Whether the ticket is archived.", "type": "boolean" }, "object_category": { "title": "Category of the object the ticket refers to.", "type": "string" }, "object_identifier": { "title": "Identifier of the object the ticket refers to.", "type": "string" }, "external_person_first_name": { "title": "First name of the external person who reported the ticket.", "type": "string" }, "external_person_last_name": { "title": "Last name of the external person who reported the ticket.", "type": "string" }, "external_person_email": { "title": "E-mail address of the external person who reported the ticket.", "type": "string" }, "external_person_phone": { "title": "Phone number of the external person who reported the ticket.", "type": "string" }, "external_person_address": { "title": "Address of the external person, as text.", "type": "string" }, "external_person_address_street_level": { "title": "Street of the external person's address.", "type": "string" }, "external_person_address_co": { "title": "Care-of line of the external person's address.", "type": "string" }, "external_person_address_city": { "title": "City of the external person's address.", "type": "string" }, "external_person_address_zip": { "title": "Postal code of the external person's address.", "type": "string" }, "external_person_address_country": { "title": "Country of the external person's address.", "type": "string" }, "external_person_birthday": { "title": "Birthday of the external person.", "type": "string", "format": "date-time" }, "external_person_gender": { "title": "Gender of the external person.", "type": "string" }, "external_company_name": { "title": "Name of the external company that reported the ticket.", "type": "string" }, "external_company_email": { "title": "E-mail address of the external company.", "type": "string" }, "external_company_phone": { "title": "Phone number of the external company.", "type": "string" }, "external_company_address": { "title": "Address of the external company, as text.", "type": "string" }, "external_company_address_street_level": { "title": "Street of the external company's address.", "type": "string" }, "external_company_address_co": { "title": "Care-of line of the external company's address.", "type": "string" }, "external_company_address_city": { "title": "City of the external company's address.", "type": "string" }, "external_company_address_zip": { "title": "Postal code of the external company's address.", "type": "string" }, "external_company_address_country": { "title": "Country of the external company's address.", "type": "string" }, "temporary_access": { "title": "Temporary access grants for the ticket.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonTemporaryAccess" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerTicket4": { "properties": { "satisfaction_requested_at": { "title": "When the customer \/ member was asked to rate the finished ticket; the apps offer the rating\nonce this is set.", "type": "string" }, "id": { "title": "Primary key of the ticket.", "description": "Internal ID.", "type": "integer" }, "ticket_type": { "title": "Type of the ticket.", "type": "string" }, "number": { "title": "Running ticket number.", "type": "integer" }, "number_string": { "title": "Ticket number as displayed to users.", "type": "string" }, "company": { "title": "Company the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "person": { "title": "Person the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "jirakey": { "title": "Key of the linked Jira issue.", "type": "string" }, "jiraid": { "title": "ID of the linked Jira issue.", "type": "string" }, "assignedusername": { "title": "Name of the assigned user, as text.", "type": "string" }, "assigned_user": { "title": "User the ticket is assigned to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "createdbyusername": { "title": "Name of the user who created the ticket, as text.", "type": "string" }, "created_by_user": { "title": "User who created the ticket.", "oneOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "status": { "title": "Status of the ticket as text.", "type": "string" }, "statusid": { "title": "ID of the status of the ticket.", "type": "string" }, "issuetype": { "title": "A type like bug, task, story", "type": "string" }, "issuecategory": { "title": "A category like website, hosting, marketing", "type": "string" }, "crm_project_category_area": { "title": "Project category area the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectCategoryArea" } ] }, "issueproject": { "title": "A project like a domain (inwendo.de) or a certain mail campaign", "type": "string" }, "crm_project": { "title": "CRM project the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject10" } ] }, "crm_project_item": { "title": "CRM project item the ticket belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem6" } ] }, "sprint": { "title": "The sprint this ticket is planned for. Tickets without a sprint are the backlog.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMSprint" } ] }, "board_order": { "title": "Manual position of the ticket inside its kanban column \/ sprint backlog", "type": "integer" }, "story_points": { "title": "Relative planning estimate used during sprint planning", "type": "integer" }, "duedate": { "title": "Due date of the ticket.", "type": "string", "format": "date-time" }, "preferred_due_date": { "title": "Due date preferred by the customer.", "type": "string", "format": "date-time" }, "customer_start_date": { "title": "Start date requested by the customer.", "type": "string", "format": "date-time" }, "customer_end_date": { "title": "End date requested by the customer.", "type": "string", "format": "date-time" }, "reopen_date": { "title": "Date on which the ticket is reopened.", "type": "string", "format": "date-time" }, "work_time_till_due_date_in_seconds": { "title": "Working time until the due date, in seconds.", "type": "integer" }, "timeestimate": { "title": "Time estimate as text.", "type": "string" }, "estimated_time_in_seconds": { "title": "Estimated time in seconds.", "type": "integer" }, "estimated_time_in_hours": { "title": "Estimated time in hours.", "type": "number", "format": "float" }, "confirmed_time_in_seconds": { "title": "Time confirmed for the ticket, in seconds.", "type": "integer" }, "priority": { "title": "Priority of the ticket.", "type": "integer" }, "business_value": { "title": "Business value of the ticket, used for scoring.", "type": "integer" }, "calculated_score": { "title": "Calculated priority score of the ticket.", "type": "number", "format": "float" }, "calculated_score_business_value": { "title": "Part of the calculated score that comes from the business value.", "type": "number", "format": "float" }, "calculated_score_due_date": { "title": "Part of the calculated score that comes from the due date.", "type": "number", "format": "float" }, "ai_urgency_score": { "title": "Interner Dringlichkeits-Score 0-100 aus der KI-Triage (TicketAiTriageHelper),\nnull = nicht bewertet. Nur fuer das Team sichtbar.", "type": "integer" }, "ai_emergency": { "title": "Die KI-Triage hat das Ticket als absoluten Notfall erkannt (das Team wurde\nzusaetzlich benachrichtigt). null = nicht geprueft.", "type": "boolean" }, "inportal": { "title": "Whether the ticket is visible in the customer portal.", "type": "boolean" }, "attachments": { "title": "Attachments of the ticket.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "archived": { "title": "Whether the ticket is archived.", "type": "boolean" }, "object_category": { "title": "Category of the object the ticket refers to.", "type": "string" }, "object_identifier": { "title": "Identifier of the object the ticket refers to.", "type": "string" }, "external_person_first_name": { "title": "First name of the external person who reported the ticket.", "type": "string" }, "external_person_last_name": { "title": "Last name of the external person who reported the ticket.", "type": "string" }, "external_person_email": { "title": "E-mail address of the external person who reported the ticket.", "type": "string" }, "external_person_phone": { "title": "Phone number of the external person who reported the ticket.", "type": "string" }, "external_person_address": { "title": "Address of the external person, as text.", "type": "string" }, "external_person_address_street_level": { "title": "Street of the external person's address.", "type": "string" }, "external_person_address_co": { "title": "Care-of line of the external person's address.", "type": "string" }, "external_person_address_city": { "title": "City of the external person's address.", "type": "string" }, "external_person_address_zip": { "title": "Postal code of the external person's address.", "type": "string" }, "external_person_address_country": { "title": "Country of the external person's address.", "type": "string" }, "external_person_birthday": { "title": "Birthday of the external person.", "type": "string", "format": "date-time" }, "external_person_gender": { "title": "Gender of the external person.", "type": "string" }, "external_company_name": { "title": "Name of the external company that reported the ticket.", "type": "string" }, "external_company_email": { "title": "E-mail address of the external company.", "type": "string" }, "external_company_phone": { "title": "Phone number of the external company.", "type": "string" }, "external_company_address": { "title": "Address of the external company, as text.", "type": "string" }, "external_company_address_street_level": { "title": "Street of the external company's address.", "type": "string" }, "external_company_address_co": { "title": "Care-of line of the external company's address.", "type": "string" }, "external_company_address_city": { "title": "City of the external company's address.", "type": "string" }, "external_company_address_zip": { "title": "Postal code of the external company's address.", "type": "string" }, "external_company_address_country": { "title": "Country of the external company's address.", "type": "string" }, "temporary_access": { "title": "Temporary access grants for the ticket.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPersonTemporaryAccess2" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerTicket5": { "properties": { "satisfaction_requested_at": { "title": "When the customer \/ member was asked to rate the finished ticket; the apps offer the rating\nonce this is set.", "type": "string" }, "id": { "title": "Primary key of the ticket.", "description": "Internal ID.", "type": "integer" }, "ticket_type": { "title": "Type of the ticket.", "type": "string" }, "number": { "title": "Running ticket number.", "type": "integer" }, "number_string": { "title": "Ticket number as displayed to users.", "type": "string" }, "jirakey": { "title": "Key of the linked Jira issue.", "type": "string" }, "jiraid": { "title": "ID of the linked Jira issue.", "type": "string" }, "assignedusername": { "title": "Name of the assigned user, as text.", "type": "string" }, "createdbyusername": { "title": "Name of the user who created the ticket, as text.", "type": "string" }, "status": { "title": "Status of the ticket as text.", "type": "string" }, "statusid": { "title": "ID of the status of the ticket.", "type": "string" }, "issuetype": { "title": "A type like bug, task, story", "type": "string" }, "issuecategory": { "title": "A category like website, hosting, marketing", "type": "string" }, "issueproject": { "title": "A project like a domain (inwendo.de) or a certain mail campaign", "type": "string" }, "duedate": { "title": "Due date of the ticket.", "type": "string", "format": "date-time" }, "preferred_due_date": { "title": "Due date preferred by the customer.", "type": "string", "format": "date-time" }, "customer_start_date": { "title": "Start date requested by the customer.", "type": "string", "format": "date-time" }, "customer_end_date": { "title": "End date requested by the customer.", "type": "string", "format": "date-time" }, "timeestimate": { "title": "Time estimate as text.", "type": "string" }, "confirmed_time_in_seconds": { "title": "Time confirmed for the ticket, in seconds.", "type": "integer" }, "priority": { "title": "Priority of the ticket.", "type": "integer" }, "inportal": { "title": "Whether the ticket is visible in the customer portal.", "type": "boolean" }, "attachments": { "title": "Attachments of the ticket.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "archived": { "title": "Whether the ticket is archived.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerTicketComment": { "properties": { "id": { "title": "Primary key of the ticket comment.", "description": "Internal ID.", "type": "integer" }, "createdbyusername": { "title": "Name of the user who wrote the comment, as text.", "type": "string" }, "created_by_user": { "title": "User who wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "displayname": { "title": "Name shown for the author of the comment.", "type": "string" }, "userposition": { "title": "Position of the author shown with the comment.", "type": "string" }, "profile_picture_url": { "title": "URL of the profile picture of the author.", "type": "string" }, "jiraid": { "title": "ID of the linked Jira comment.", "type": "string" }, "inportal": { "title": "Whether the comment is visible in the customer portal.", "type": "boolean" }, "is_draft": { "title": "Whether the comment is an unsent draft.", "type": "boolean" }, "attachments": { "title": "Attachments of the comment.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "CustomerTicketComment2": { "type": "object" }, "CustomizedBillingItem": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem21" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem10": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem19" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer12" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem11": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem20" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer13" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem12": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem27" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer14" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem13": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem28" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer15" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem14": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem29" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer16" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem15": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem30" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer17" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem16": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem16" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer18" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem17": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem8" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer19" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem2": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem5" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer2" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem3": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem22" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer4" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem4": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem23" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer5" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem5": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem25" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer6" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem6": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem26" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer7" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem7": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem15" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer9" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem8": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem17" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer10" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "CustomizedBillingItem9": { "required": [ "name", "description", "quantity" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "parent": { "title": "Billing item this customized item is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem18" } ] }, "offer": { "title": "Offer the customized item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer11" } ] }, "quantity": { "title": "Quantity of the item.", "type": "number", "format": "float" } }, "type": "object" }, "DisabledUiFunction": { "properties": { "id": { "title": "Primary key of the disabled function.", "description": "Internal ID.", "type": "integer" }, "entity_type": { "title": "Entity the function is hidden for, for example Person.", "type": "string" }, "function_type": { "title": "Type of the hidden function, for example button or menu.", "type": "string" }, "function_scope": { "title": "Access scope the function belongs to.", "type": "string" }, "function_access_type": { "title": "Access type the function belongs to.", "type": "integer" }, "function_name": { "title": "Technical name of the function.", "type": "string" }, "function_is_internal": { "title": "The function is only hidden for internal users.", "type": "boolean" }, "info_mode": { "title": "Display mode of the info text of the function.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "Donation": { "required": [ "amount", "donor_name" ], "properties": { "id": { "title": "Primary key of the donation.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the donation.", "description": "Used instead of the ID.", "type": "string" }, "number": { "title": "Number of the donation.", "type": "integer" }, "number_string": { "title": "Number of the donation as text, including prefix.", "type": "string" }, "amount": { "title": "Amount of the donation.", "type": "number", "format": "float", "minimum": 0, "exclusiveMinimum": true }, "currency": { "title": "Currency of the amount, for example EUR.", "type": "string" }, "donation_date": { "title": "Date of the donation.", "type": "string", "format": "date-time" }, "status": { "title": "Status of the donation, for example open, paid or canceled.", "type": "string" }, "kind": { "title": "Kind of the donation, for example money or item.", "type": "string" }, "anonymous": { "title": "The donor gave no name: not linked to a person, never a receipt (proposal U2,\ndonation_anonymous_enabled).", "type": "boolean" }, "receipt_wanted": { "title": "Whether the donor wants a Zuwendungsbest\u00e4tigung (proposal U2). Without it the donor gets no\nreceipt by mail, link or self-service and the donation stays off the collective receipt; the\noffice can still issue one.", "type": "boolean" }, "donor_name": { "title": "Name of the donor.", "type": "string" }, "donor_secondary_name": { "title": "Second name line of the donor.", "type": "string" }, "donor_email": { "title": "E-mail address of the donor.", "type": "string" }, "donor_address_street_level": { "title": "Street and house number of the donor.", "type": "string" }, "donor_address_zip": { "title": "Postal code of the donor.", "type": "string" }, "donor_address_city": { "title": "City of the donor.", "type": "string" }, "donor_address_country": { "title": "Country of the donor.", "type": "string" }, "message": { "title": "Message of the donor.", "type": "string" }, "payment_provider_status": { "title": "Status at the payment provider.", "type": "string" }, "payment_provider_reference": { "title": "Reference at the payment provider.", "type": "string" }, "payment_provider_transaction_reference": { "title": "Transaction reference at the payment provider.", "type": "string" }, "archived": { "title": "The donation is archived.", "type": "boolean" }, "crm_person": { "title": "Person who donated.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "crm_company": { "title": "Company that donated.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "donation_goal": { "title": "Donation goal the donation supports.", "oneOf": [ { "$ref": "#\/components\/schemas\/DonationGoal" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "DonationGoal": { "required": [ "name" ], "properties": { "id": { "title": "Primary key of the donation goal.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the donation goal.", "type": "string" }, "description": { "title": "Description of the donation goal shown to donors.", "type": "string" }, "enabled": { "title": "The donation goal is enabled.", "type": "boolean" }, "sort_order": { "title": "Sort order of the goal in lists.", "type": "integer" }, "amounts": { "title": "Comma-separated list of available amounts for this goal.", "type": "string" }, "target_amount": { "title": "The amount the goal collects for, shown with a progress bar (proposal U1,\ndonation_goal_progress_enabled).", "type": "number", "format": "float" }, "end_date": { "title": "The last day the goal takes donations (proposal U1).", "type": "string", "format": "date-time" }, "currency": { "title": "Currency of the goal, for example EUR.", "type": "string" }, "allow_one_time": { "title": "Donors can give a one-time donation.", "type": "boolean" }, "allow_recurring": { "title": "Donors can set up a recurring donation.", "type": "boolean" }, "allow_custom_amount": { "title": "Donors can enter their own amount.", "type": "boolean" }, "mail_donation_text": { "title": "Text of the e-mail sent after a donation.", "type": "string" }, "mail_donation_subject": { "title": "Subject of the e-mail sent after a donation.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmployeeDocument": { "properties": { "id": { "title": "Primary key of the employee document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the document.", "description": "Used instead of the ID.", "type": "string" }, "title": { "title": "Title of the document.", "type": "string" }, "description": { "title": "Description of the document.", "type": "string" }, "document_type": { "title": "Type of the document, for example contract or notice.", "type": "string" }, "category": { "title": "Category of the document.", "type": "string" }, "status": { "title": "Status of the document, for example draft or published.", "type": "string" }, "requires_acknowledgment": { "title": "Employees must acknowledge the document.", "type": "boolean" }, "requires_signature": { "title": "Employees must sign the document.", "type": "boolean" }, "requires_form_filling": { "title": "Employees must fill in a form.", "type": "boolean" }, "target_all_employees": { "title": "The document is for all employees.", "type": "boolean" }, "due_date": { "title": "Date until which the response is due.", "type": "string", "format": "date-time" }, "published_at": { "title": "Time the document was published.", "type": "string", "format": "date-time" }, "attachment": { "title": "File attached to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "created_by_user": { "title": "Login user who created the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocument2": { "properties": { "title": { "title": "Title of the document.", "type": "string" }, "description": { "title": "Description of the document.", "type": "string" }, "document_type": { "title": "Type of the document, for example contract or notice.", "type": "string" }, "category": { "title": "Category of the document.", "type": "string" }, "status": { "title": "Status of the document, for example draft or published.", "type": "string" }, "requires_acknowledgment": { "title": "Employees must acknowledge the document.", "type": "boolean" }, "requires_signature": { "title": "Employees must sign the document.", "type": "boolean" }, "requires_form_filling": { "title": "Employees must fill in a form.", "type": "boolean" }, "target_all_employees": { "title": "The document is for all employees.", "type": "boolean" }, "due_date": { "title": "Date until which the response is due.", "type": "string", "format": "date-time" }, "target_employees": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson41" } }, "target_contract_groups": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentContractGroup5" } }, "target_organizations": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentOrganization3" } } }, "type": "object" }, "EmployeeDocument3": { "properties": { "id": { "title": "Primary key of the employee document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the document.", "description": "Used instead of the ID.", "type": "string" }, "title": { "title": "Title of the document.", "type": "string" }, "description": { "title": "Description of the document.", "type": "string" }, "document_type": { "title": "Type of the document, for example contract or notice.", "type": "string" }, "category": { "title": "Category of the document.", "type": "string" }, "status": { "title": "Status of the document, for example draft or published.", "type": "string" }, "requires_acknowledgment": { "title": "Employees must acknowledge the document.", "type": "boolean" }, "requires_signature": { "title": "Employees must sign the document.", "type": "boolean" }, "requires_form_filling": { "title": "Employees must fill in a form.", "type": "boolean" }, "target_all_employees": { "title": "The document is for all employees.", "type": "boolean" }, "due_date": { "title": "Date until which the response is due.", "type": "string", "format": "date-time" }, "published_at": { "title": "Time the document was published.", "type": "string", "format": "date-time" }, "attachment": { "title": "File attached to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "created_by_user": { "title": "Login user who created the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "created_by_person": { "title": "Person who created the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "target_employees": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "target_contract_groups": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } }, "target_organizations": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentOrganization4" } }, "acknowledgments": { "title": "Acknowledgments of the document by employees.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocumentAcknowledgment3" } }, "comments": { "title": "Comments on the document.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocumentComment3" } }, "responses": { "title": "Responses of employees to the document.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployeeDocumentResponse3" } }, "last_reminder_sent_at": { "title": "Time the last reminder was sent.", "type": "string", "format": "date-time" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocument4": { "properties": { "id": { "title": "Primary key of the employee document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the document.", "description": "Used instead of the ID.", "type": "string" }, "title": { "title": "Title of the document.", "type": "string" }, "description": { "title": "Description of the document.", "type": "string" }, "document_type": { "title": "Type of the document, for example contract or notice.", "type": "string" }, "category": { "title": "Category of the document.", "type": "string" }, "status": { "title": "Status of the document, for example draft or published.", "type": "string" }, "requires_acknowledgment": { "title": "Employees must acknowledge the document.", "type": "boolean" }, "requires_signature": { "title": "Employees must sign the document.", "type": "boolean" }, "requires_form_filling": { "title": "Employees must fill in a form.", "type": "boolean" }, "target_all_employees": { "title": "The document is for all employees.", "type": "boolean" }, "due_date": { "title": "Date until which the response is due.", "type": "string", "format": "date-time" }, "published_at": { "title": "Time the document was published.", "type": "string", "format": "date-time" }, "attachment": { "title": "File attached to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "created_by_user": { "title": "Login user who created the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocument5": { "properties": { "id": { "title": "Primary key of the employee document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the document.", "description": "Used instead of the ID.", "type": "string" }, "title": { "title": "Title of the document.", "type": "string" }, "description": { "title": "Description of the document.", "type": "string" }, "document_type": { "title": "Type of the document, for example contract or notice.", "type": "string" }, "category": { "title": "Category of the document.", "type": "string" }, "status": { "title": "Status of the document, for example draft or published.", "type": "string" }, "requires_acknowledgment": { "title": "Employees must acknowledge the document.", "type": "boolean" }, "requires_signature": { "title": "Employees must sign the document.", "type": "boolean" }, "requires_form_filling": { "title": "Employees must fill in a form.", "type": "boolean" }, "target_all_employees": { "title": "The document is for all employees.", "type": "boolean" }, "due_date": { "title": "Date until which the response is due.", "type": "string", "format": "date-time" }, "published_at": { "title": "Time the document was published.", "type": "string", "format": "date-time" }, "attachment": { "title": "File attached to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "created_by_user": { "title": "Login user who created the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocumentAcknowledgment": { "properties": { "id": { "title": "Primary key of the acknowledgment.", "description": "Internal ID.", "type": "integer" }, "document": { "title": "Employee document that was acknowledged.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmployeeDocument4" } ] }, "user": { "title": "User who acknowledged the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person who acknowledged the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "contract": { "title": "Employment contract the acknowledgment belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract14" } ] }, "type": { "title": "Type of the acknowledgment.", "type": "string" }, "signature_data": { "title": "Signature data captured for the acknowledgment.", "type": "string" }, "signature_ip_address": { "title": "IP address at the time of the signature.", "type": "string" }, "signature_user_agent": { "title": "User agent at the time of the signature.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocumentAcknowledgment2": { "properties": { "id": { "title": "Primary key of the acknowledgment.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who acknowledged the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person who acknowledged the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "contract": { "title": "Employment contract the acknowledgment belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract15" } ] }, "type": { "title": "Type of the acknowledgment.", "type": "string" }, "signature_data": { "title": "Signature data captured for the acknowledgment.", "type": "string" }, "signature_ip_address": { "title": "IP address at the time of the signature.", "type": "string" }, "signature_user_agent": { "title": "User agent at the time of the signature.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocumentAcknowledgment3": { "properties": { "id": { "title": "Primary key of the acknowledgment.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User who acknowledged the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person who acknowledged the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "type": { "title": "Type of the acknowledgment.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocumentComment": { "properties": { "id": { "title": "Primary key of the employee document comment.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user who wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Text of the comment.", "type": "string" }, "attachments": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocumentComment2": { "properties": { "person": { "title": "Person who wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson45" } ] }, "description": { "title": "Text of the comment.", "type": "string" } }, "type": "object" }, "EmployeeDocumentComment3": { "properties": { "id": { "title": "Primary key of the employee document comment.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user who wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Text of the comment.", "type": "string" }, "attachments": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocumentResponse": { "properties": { "id": { "title": "Primary key of the employee document response.", "description": "Internal ID.", "type": "integer" }, "document": { "title": "Document the response belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmployeeDocument5" } ] }, "user": { "title": "Login user who responded.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person who responded.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "attachment": { "title": "File sent with the response.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "status": { "title": "Status of the response, for example submitted or accepted.", "type": "string" }, "review_note": { "title": "Note of the reviewer.", "type": "string" }, "reviewed_by_user": { "title": "Login user who reviewed the response.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "reviewed_at": { "title": "Time the response was reviewed.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocumentResponse2": { "properties": { "id": { "title": "Primary key of the employee document response.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user who responded.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person who responded.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "attachment": { "title": "File sent with the response.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "status": { "title": "Status of the response, for example submitted or accepted.", "type": "string" }, "review_note": { "title": "Note of the reviewer.", "type": "string" }, "reviewed_by_user": { "title": "Login user who reviewed the response.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "reviewed_at": { "title": "Time the response was reviewed.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmployeeDocumentResponse3": { "properties": { "id": { "title": "Primary key of the employee document response.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user who responded.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person who responded.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "attachment": { "title": "File sent with the response.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "status": { "title": "Status of the response, for example submitted or accepted.", "type": "string" }, "review_note": { "title": "Note of the reviewer.", "type": "string" }, "reviewed_at": { "title": "Time the response was reviewed.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmploymentContract": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract10": { "type": "object" }, "EmploymentContract11": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract12": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract13": { "type": "object" }, "EmploymentContract14": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract15": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract16": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract17": { "type": "object" }, "EmploymentContract18": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract19": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract2": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract3": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract4": { "type": "object" }, "EmploymentContract5": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract6": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContract7": { "type": "object" }, "EmploymentContract8": { "type": "object" }, "EmploymentContract9": { "properties": { "staged_absence_approval": { "title": "null inherits group then organization policy; existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment contract.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the contract.", "description": "Used instead of the ID.", "type": "string" }, "user": { "title": "Login user of the employee.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "week_full_time_total_days": { "title": "Total working days per week for a full-time contract.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "start": { "title": "Start date of the contract.", "type": "string", "format": "date-time" }, "end": { "title": "End date of the contract.", "type": "string", "format": "date-time" }, "fixed_term_status": { "title": "Befristung: PERMANENT (unbefristet, default), FIXED_TERM or EXTENDED (FIXED_TERM_STATUS_*).", "type": "string" }, "fixed_term_end": { "title": "Befristet bis (erster Zeitraum).", "type": "string", "format": "date-time" }, "fixed_term_extension_end": { "title": "Befristet bis nach Verl\u00e4ngerung.", "type": "string", "format": "date-time" }, "probation_end": { "title": "Probezeit bis; filled from the template's probationMonths when a contract is created without it.", "type": "string", "format": "date-time" }, "number": { "title": "Contract number.", "type": "string" }, "description": { "title": "Description of the contract.", "type": "string" }, "archived": { "title": "The contract is archived.", "type": "boolean" }, "allow_app_time_tracking": { "title": "The employee may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "The employee may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "The employee may manage absences in the app.", "type": "boolean" }, "force_no_auto_break": { "title": "Automatic breaks are not added for this contract.", "type": "boolean" }, "work_time_mode": { "title": "How the target working time is defined - null behaves as WEEKDAY_HOURS so existing\ncontracts keep their previous behaviour unchanged.", "type": "string" }, "holiday_credit_mode": { "title": "Holiday credit for WEEK_TOTAL contracts - null behaves as WEEKDAY_TARGET (previous\nbehaviour, only meaningful for WEEKDAY_HOURS contracts).", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "ISO weekday bitmask (Mo=1 ... So=64) of the days this WEEK_TOTAL contract can be\nplanned \/ takes vacation on - null behaves as Mo-Fr.", "type": "integer" }, "request_lead_time_days": { "title": "Days an absence request has to be handed in ahead of its first day (\"Bearbeitungs-\nfrist\"). null falls back to the contract group and from there to the installation\nwide setting, so an existing contract keeps behaving exactly as before.", "type": "integer" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\ngroup (which inherits the organisation).", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "EmploymentContractChangeRequest": { "properties": { "requested_by_name": { "type": "string" }, "id": { "title": "Primary key of the contract change request.", "description": "Internal ID.", "type": "integer" }, "contract": { "title": "Contract the change applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract3" } ] }, "requested_by_user": { "title": "Login user who requested the change.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "requested_by_person": { "title": "Person who requested the change.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "start": { "title": "First day the new distribution applies; always a month start beyond the change deadline.", "type": "string", "format": "date-time" }, "monday_hours": { "title": "Requested working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Requested working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Requested working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Requested working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Requested working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Requested working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Requested working hours on Sunday.", "type": "number", "format": "float" }, "week_total_hours": { "title": "Sum of the requested weekday hours, kept for lists and for the auto-apply rule.", "type": "number", "format": "float" }, "previous_week_total_hours": { "title": "Weekly total the contract had for the requested month when the request was made.", "type": "number", "format": "float" }, "status": { "title": "Status of the request, for example open, approved or rejected.", "type": "string" }, "reason": { "title": "Why the lead asks for the change; shown to HR.", "type": "string" }, "decided_by_user": { "title": "Login user who decided on the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "decided_at": { "title": "Time the request was decided.", "type": "string", "format": "date-time" }, "decision_comment": { "title": "Comment on the decision.", "type": "string" }, "vacation_days_mode": { "title": "HR's decision on the annual vacation entitlement when approving: null keeps the\nentitlement as it is, PROPORTIONAL recalculates it from the new working days,\nMANUAL sets yearVacationDays. Uses the EmploymentContractModifier::VACATION_DAYS_MODE_* values.", "type": "string" }, "year_vacation_days": { "title": "The new annual vacation entitlement HR sets with vacationDaysMode MANUAL.", "type": "number", "format": "float" }, "auto_applied": { "title": "True when the confirmation happened without an HR decision (unchanged weekly total,\ninstallation setting).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmploymentContractChangeRequest2": { "properties": { "contract": { "title": "Contract the change applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract4" } ] }, "start": { "title": "First day the new distribution applies; always a month start beyond the change deadline.", "type": "string", "format": "date-time" }, "monday_hours": { "title": "Requested working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Requested working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Requested working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Requested working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Requested working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Requested working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Requested working hours on Sunday.", "type": "number", "format": "float" }, "status": { "title": "Status of the request, for example open, approved or rejected.", "type": "string" }, "reason": { "title": "Why the lead asks for the change; shown to HR.", "type": "string" }, "decision_comment": { "title": "Comment on the decision.", "type": "string" }, "vacation_days_mode": { "title": "HR's decision on the annual vacation entitlement when approving: null keeps the\nentitlement as it is, PROPORTIONAL recalculates it from the new working days,\nMANUAL sets yearVacationDays. Uses the EmploymentContractModifier::VACATION_DAYS_MODE_* values.", "type": "string" }, "year_vacation_days": { "title": "The new annual vacation entitlement HR sets with vacationDaysMode MANUAL.", "type": "number", "format": "float" } }, "type": "object" }, "EmploymentContractChangeRequest3": { "properties": { "requested_by_name": { "type": "string" }, "id": { "title": "Primary key of the contract change request.", "description": "Internal ID.", "type": "integer" }, "contract": { "title": "Contract the change applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract5" } ] }, "requested_by_user": { "title": "Login user who requested the change.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "requested_by_person": { "title": "Person who requested the change.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "start": { "title": "First day the new distribution applies; always a month start beyond the change deadline.", "type": "string", "format": "date-time" }, "monday_hours": { "title": "Requested working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Requested working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Requested working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Requested working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Requested working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Requested working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Requested working hours on Sunday.", "type": "number", "format": "float" }, "week_total_hours": { "title": "Sum of the requested weekday hours, kept for lists and for the auto-apply rule.", "type": "number", "format": "float" }, "previous_week_total_hours": { "title": "Weekly total the contract had for the requested month when the request was made.", "type": "number", "format": "float" }, "status": { "title": "Status of the request, for example open, approved or rejected.", "type": "string" }, "reason": { "title": "Why the lead asks for the change; shown to HR.", "type": "string" }, "decided_by_user": { "title": "Login user who decided on the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "decided_at": { "title": "Time the request was decided.", "type": "string", "format": "date-time" }, "decision_comment": { "title": "Comment on the decision.", "type": "string" }, "vacation_days_mode": { "title": "HR's decision on the annual vacation entitlement when approving: null keeps the\nentitlement as it is, PROPORTIONAL recalculates it from the new working days,\nMANUAL sets yearVacationDays. Uses the EmploymentContractModifier::VACATION_DAYS_MODE_* values.", "type": "string" }, "year_vacation_days": { "title": "The new annual vacation entitlement HR sets with vacationDaysMode MANUAL.", "type": "number", "format": "float" }, "auto_applied": { "title": "True when the confirmation happened without an HR decision (unchanged weekly total,\ninstallation setting).", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmploymentContractGroup": { "properties": { "staged_absence_approval": { "title": "null inherits the organization; false explicitly disables staged approval.", "type": "boolean" }, "shift_booking_sync": { "title": "L35: shifts as availabilities \/ appointments in the booking area; null inherits the\norganisation, false switches it off for this group.", "type": "boolean" }, "id": { "title": "Primary key of the contract group.", "description": "Internal ID.", "type": "integer" }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "week_total_days": { "title": "Working days per week.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "month_vacation_days": { "title": "Vacation days per month.", "type": "number", "format": "float" }, "year_vacation_weeks": { "title": "Vacation weeks per year.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "allow_app_time_tracking": { "title": "Whether time tracking in the app is allowed.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Whether time tracking with a scanner is allowed.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Whether non-work time can be managed in the app.", "type": "boolean" }, "request_lead_time_days": { "title": "Days an absence request of this group has to be handed in ahead of its first day.", "description": "null falls back to the installation wide setting - an existing group therefore\nbehaves exactly as before.", "type": "integer" }, "school_holiday_region": { "title": "U09: the school calendar of this group when it differs from the organisation's\n(apprentices attending school in another Bundesland). null = the organisation's.", "oneOf": [ { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentContractGroup5": { "type": "object" }, "EmploymentContractGroup8": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EmploymentContractTemplate": { "properties": { "id": { "title": "Primary key of the contract template.", "description": "Internal ID.", "type": "integer" }, "template_type": { "title": "Type of the template, for example full-time or part-time.", "type": "string" }, "work_time_mode": { "title": "Work time mode of the template.", "type": "string" }, "vacation_days_mode": { "title": "U01: how yearVacationDays of the template is meant. MANUAL copies the value as it is;\nPROPORTIONAL treats it as the entitlement for the template's working days per week and\nscales it to the working days of the new contract (30 days at 5 days\/week \u2192 18 at 3).", "type": "string" }, "leadership_may_change_weekdays": { "title": "L13\/U22: leads of contracts of this type may hand in a dated redistribution of the\nweekly working days as a change request.", "type": "boolean" }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "flexible_vacation_days": { "title": "U02\/U18: how many of the yearly vacation days of this category are held back for\nsupplement requests instead of the annual plan. null = the installation default\n(setting non_work_time_flexible_vacation_days).", "type": "number", "format": "float" }, "supplement_processing_deadline_days": { "title": "U20: processing deadline of a supplement request of this category in days after\nreceipt (Teamer: 14). null = the general deadline of the installation.", "type": "integer" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "holiday_credit_mode": { "title": "How holiday credit is calculated, for example fixed or by hours.", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "Bitmask of the weekdays planned in the template.", "type": "integer" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "probation_months": { "title": "probation period in months, informational", "type": "integer" }, "default_contract_duration_months": { "title": "default fixed term in months (null = unlimited), informational", "type": "integer" }, "monthly_earnings_limit": { "title": "warning limit, e.g. the Minijob earnings limit - maintained as data, never hardcoded", "type": "number", "format": "float" }, "max_week_hours_limit": { "title": "warning limit, e.g. 20h for working students", "type": "number", "format": "float" }, "allow_app_time_tracking": { "title": "Employees may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Employees may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Employees may manage absences in the app.", "type": "boolean" }, "employment_contract_group": { "title": "Contract group the template belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "sort_order": { "title": "Sort order of the template in lists.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmploymentContractTemplate2": { "properties": { "template_type": { "title": "Type of the template, for example full-time or part-time.", "type": "string" }, "work_time_mode": { "title": "Work time mode of the template.", "type": "string" }, "vacation_days_mode": { "title": "U01: how yearVacationDays of the template is meant. MANUAL copies the value as it is;\nPROPORTIONAL treats it as the entitlement for the template's working days per week and\nscales it to the working days of the new contract (30 days at 5 days\/week \u2192 18 at 3).", "type": "string" }, "leadership_may_change_weekdays": { "title": "L13\/U22: leads of contracts of this type may hand in a dated redistribution of the\nweekly working days as a change request.", "type": "boolean" }, "week_total_hours": { "title": "Total working hours per week.", "type": "number", "format": "float" }, "reserved_hours_preparation": { "title": "L03: weekly hours reserved for Vorbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_follow_up": { "title": "L03: weekly hours reserved for Nachbereitung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_travel": { "title": "L03: weekly hours reserved for Fahrt - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "reserved_hours_flexible": { "title": "L03: weekly hours reserved for freie Einteilung - part of the contract hours but not plannable\nin the shift plan. null = none.", "type": "number", "format": "float" }, "flexible_vacation_days": { "title": "U02\/U18: how many of the yearly vacation days of this category are held back for\nsupplement requests instead of the annual plan. null = the installation default\n(setting non_work_time_flexible_vacation_days).", "type": "number", "format": "float" }, "supplement_processing_deadline_days": { "title": "U20: processing deadline of a supplement request of this category in days after\nreceipt (Teamer: 14). null = the general deadline of the installation.", "type": "integer" }, "week_total_days": { "title": "Total working days per week.", "type": "number", "format": "float" }, "monday_hours": { "title": "Working hours on Monday.", "type": "number", "format": "float" }, "tuesday_hours": { "title": "Working hours on Tuesday.", "type": "number", "format": "float" }, "wednesday_hours": { "title": "Working hours on Wednesday.", "type": "number", "format": "float" }, "thursday_hours": { "title": "Working hours on Thursday.", "type": "number", "format": "float" }, "friday_hours": { "title": "Working hours on Friday.", "type": "number", "format": "float" }, "saturday_hours": { "title": "Working hours on Saturday.", "type": "number", "format": "float" }, "sunday_hours": { "title": "Working hours on Sunday.", "type": "number", "format": "float" }, "year_vacation_days": { "title": "Vacation days per year.", "type": "number", "format": "float" }, "holiday_credit_mode": { "title": "How holiday credit is calculated, for example fixed or by hours.", "type": "string" }, "holiday_credit_fixed_seconds": { "title": "Fixed holiday credit in seconds.", "type": "integer" }, "planning_weekdays_bitmask": { "title": "Bitmask of the weekdays planned in the template.", "type": "integer" }, "netto_hour_cost": { "title": "Net cost per hour.", "type": "number", "format": "float" }, "brutto_hour_cost": { "title": "Gross cost per hour.", "type": "number", "format": "float" }, "probation_months": { "title": "probation period in months, informational", "type": "integer" }, "default_contract_duration_months": { "title": "default fixed term in months (null = unlimited), informational", "type": "integer" }, "monthly_earnings_limit": { "title": "warning limit, e.g. the Minijob earnings limit - maintained as data, never hardcoded", "type": "number", "format": "float" }, "max_week_hours_limit": { "title": "warning limit, e.g. 20h for working students", "type": "number", "format": "float" }, "allow_app_time_tracking": { "title": "Employees may track time in the app.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Employees may track time with the scanner.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Employees may manage absences in the app.", "type": "boolean" }, "sort_order": { "title": "Sort order of the template in lists.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentOrganization": { "properties": { "staged_absence_approval": { "title": "null inherits the organization policy (contracts); existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment organization.", "description": "Internal ID.", "type": "integer" }, "allow_app_time_tracking": { "title": "Whether time tracking in the app is allowed.", "type": "boolean" }, "school_holiday_region": { "title": "U09: the school calendar (Bundesland) of this organisation; groups may override it.", "oneOf": [ { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } ] }, "organization_unit": { "title": "L01: the node of the organisation tree this organisation hangs on (Einrichtung,\nBereich, Gesch\u00e4ftsstelle ...). Leaders of that node and of the nodes above lead this\norganisation as well.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit4" } ] }, "shift_booking_sync": { "title": "L35: published shifts of this organisation's people appear as availabilities in the\nevent\/booking area and a shift may be turned into an appointment. null = off.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Whether time tracking with a scanner is allowed.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Whether non-work time can be managed in the app.", "type": "boolean" }, "include_in_auto_export": { "title": "Whether the organization is included in the automatic export.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EmploymentOrganization10": { "properties": { "staged_absence_approval": { "title": "null inherits the organization policy (contracts); existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment organization.", "description": "Internal ID.", "type": "integer" }, "allow_app_time_tracking": { "title": "Whether time tracking in the app is allowed.", "type": "boolean" }, "school_holiday_region": { "title": "U09: the school calendar (Bundesland) of this organisation; groups may override it.", "oneOf": [ { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } ] }, "organization_unit": { "title": "L01: the node of the organisation tree this organisation hangs on (Einrichtung,\nBereich, Gesch\u00e4ftsstelle ...). Leaders of that node and of the nodes above lead this\norganisation as well.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit11" } ] }, "shift_booking_sync": { "title": "L35: published shifts of this organisation's people appear as availabilities in the\nevent\/booking area and a shift may be turned into an appointment. null = off.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Whether time tracking with a scanner is allowed.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Whether non-work time can be managed in the app.", "type": "boolean" }, "include_in_auto_export": { "title": "Whether the organization is included in the automatic export.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EmploymentOrganization2": { "properties": { "staged_absence_approval": { "title": "null inherits the organization policy (contracts); existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment organization.", "description": "Internal ID.", "type": "integer" }, "allow_app_time_tracking": { "title": "Whether time tracking in the app is allowed.", "type": "boolean" }, "school_holiday_region": { "title": "U09: the school calendar (Bundesland) of this organisation; groups may override it.", "oneOf": [ { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } ] }, "organization_unit": { "title": "L01: the node of the organisation tree this organisation hangs on (Einrichtung,\nBereich, Gesch\u00e4ftsstelle ...). Leaders of that node and of the nodes above lead this\norganisation as well.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit5" } ] }, "shift_booking_sync": { "title": "L35: published shifts of this organisation's people appear as availabilities in the\nevent\/booking area and a shift may be turned into an appointment. null = off.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Whether time tracking with a scanner is allowed.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Whether non-work time can be managed in the app.", "type": "boolean" }, "include_in_auto_export": { "title": "Whether the organization is included in the automatic export.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EmploymentOrganization3": { "type": "object" }, "EmploymentOrganization4": { "properties": { "staged_absence_approval": { "title": "null inherits the organization policy (contracts); existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment organization.", "description": "Internal ID.", "type": "integer" }, "allow_app_time_tracking": { "title": "Whether time tracking in the app is allowed.", "type": "boolean" }, "school_holiday_region": { "title": "U09: the school calendar (Bundesland) of this organisation; groups may override it.", "oneOf": [ { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } ] }, "organization_unit": { "title": "L01: the node of the organisation tree this organisation hangs on (Einrichtung,\nBereich, Gesch\u00e4ftsstelle ...). Leaders of that node and of the nodes above lead this\norganisation as well.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit7" } ] }, "shift_booking_sync": { "title": "L35: published shifts of this organisation's people appear as availabilities in the\nevent\/booking area and a shift may be turned into an appointment. null = off.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Whether time tracking with a scanner is allowed.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Whether non-work time can be managed in the app.", "type": "boolean" }, "include_in_auto_export": { "title": "Whether the organization is included in the automatic export.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EmploymentOrganization5": { "properties": { "staged_absence_approval": { "title": "null inherits the organization policy (contracts); existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment organization.", "description": "Internal ID.", "type": "integer" }, "allow_app_time_tracking": { "title": "Whether time tracking in the app is allowed.", "type": "boolean" }, "school_holiday_region": { "title": "U09: the school calendar (Bundesland) of this organisation; groups may override it.", "oneOf": [ { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } ] }, "organization_unit": { "title": "L01: the node of the organisation tree this organisation hangs on (Einrichtung,\nBereich, Gesch\u00e4ftsstelle ...). Leaders of that node and of the nodes above lead this\norganisation as well.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit8" } ] }, "shift_booking_sync": { "title": "L35: published shifts of this organisation's people appear as availabilities in the\nevent\/booking area and a shift may be turned into an appointment. null = off.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Whether time tracking with a scanner is allowed.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Whether non-work time can be managed in the app.", "type": "boolean" }, "include_in_auto_export": { "title": "Whether the organization is included in the automatic export.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EmploymentOrganization6": { "properties": { "staged_absence_approval": { "title": "null inherits the organization policy (contracts); existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment organization.", "description": "Internal ID.", "type": "integer" }, "allow_app_time_tracking": { "title": "Whether time tracking in the app is allowed.", "type": "boolean" }, "school_holiday_region": { "title": "U09: the school calendar (Bundesland) of this organisation; groups may override it.", "oneOf": [ { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } ] }, "organization_unit": { "title": "L01: the node of the organisation tree this organisation hangs on (Einrichtung,\nBereich, Gesch\u00e4ftsstelle ...). Leaders of that node and of the nodes above lead this\norganisation as well.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit6" } ] }, "shift_booking_sync": { "title": "L35: published shifts of this organisation's people appear as availabilities in the\nevent\/booking area and a shift may be turned into an appointment. null = off.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Whether time tracking with a scanner is allowed.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Whether non-work time can be managed in the app.", "type": "boolean" }, "include_in_auto_export": { "title": "Whether the organization is included in the automatic export.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EmploymentOrganization7": { "properties": { "staged_absence_approval": { "title": "null inherits the organization policy (contracts); existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment organization.", "description": "Internal ID.", "type": "integer" }, "allow_app_time_tracking": { "title": "Whether time tracking in the app is allowed.", "type": "boolean" }, "school_holiday_region": { "title": "U09: the school calendar (Bundesland) of this organisation; groups may override it.", "oneOf": [ { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } ] }, "organization_unit": { "title": "L01: the node of the organisation tree this organisation hangs on (Einrichtung,\nBereich, Gesch\u00e4ftsstelle ...). Leaders of that node and of the nodes above lead this\norganisation as well.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit" } ] }, "shift_booking_sync": { "title": "L35: published shifts of this organisation's people appear as availabilities in the\nevent\/booking area and a shift may be turned into an appointment. null = off.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Whether time tracking with a scanner is allowed.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Whether non-work time can be managed in the app.", "type": "boolean" }, "include_in_auto_export": { "title": "Whether the organization is included in the automatic export.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EmploymentOrganization8": { "properties": { "staged_absence_approval": { "title": "null inherits the organization policy (contracts); existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment organization.", "description": "Internal ID.", "type": "integer" }, "allow_app_time_tracking": { "title": "Whether time tracking in the app is allowed.", "type": "boolean" }, "school_holiday_region": { "title": "U09: the school calendar (Bundesland) of this organisation; groups may override it.", "oneOf": [ { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } ] }, "organization_unit": { "title": "L01: the node of the organisation tree this organisation hangs on (Einrichtung,\nBereich, Gesch\u00e4ftsstelle ...). Leaders of that node and of the nodes above lead this\norganisation as well.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit9" } ] }, "shift_booking_sync": { "title": "L35: published shifts of this organisation's people appear as availabilities in the\nevent\/booking area and a shift may be turned into an appointment. null = off.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Whether time tracking with a scanner is allowed.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Whether non-work time can be managed in the app.", "type": "boolean" }, "include_in_auto_export": { "title": "Whether the organization is included in the automatic export.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EmploymentOrganization9": { "properties": { "staged_absence_approval": { "title": "null inherits the organization policy (contracts); existing installations stay off.", "type": "boolean" }, "id": { "title": "Primary key of the employment organization.", "description": "Internal ID.", "type": "integer" }, "allow_app_time_tracking": { "title": "Whether time tracking in the app is allowed.", "type": "boolean" }, "school_holiday_region": { "title": "U09: the school calendar (Bundesland) of this organisation; groups may override it.", "oneOf": [ { "$ref": "#\/components\/schemas\/SchoolHolidayRegion" } ] }, "organization_unit": { "title": "L01: the node of the organisation tree this organisation hangs on (Einrichtung,\nBereich, Gesch\u00e4ftsstelle ...). Leaders of that node and of the nodes above lead this\norganisation as well.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit10" } ] }, "shift_booking_sync": { "title": "L35: published shifts of this organisation's people appear as availabilities in the\nevent\/booking area and a shift may be turned into an appointment. null = off.", "type": "boolean" }, "allow_scanner_time_tracking": { "title": "Whether time tracking with a scanner is allowed.", "type": "boolean" }, "allow_app_non_work_time_management": { "title": "Whether non-work time can be managed in the app.", "type": "boolean" }, "include_in_auto_export": { "title": "Whether the organization is included in the automatic export.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EmploymentQualification": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification10": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification10" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification11": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification11" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification12": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification12" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification13": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification13" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification14": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification14" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification15": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification15" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification16": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification16" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification17": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification17" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification18": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification18" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification19": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification19" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification2": { "properties": { "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup2" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification20": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification20" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification21": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification21" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification22": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification22" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification23": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification23" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification24": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification24" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification25": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification25" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification26": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification26" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification27": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification27" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification28": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification28" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification29": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification29" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification3": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification3" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification30": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification30" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification31": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification31" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification32": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification32" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification33": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification33" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification34": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification34" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification35": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification35" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification36": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification36" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification37": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification37" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification38": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification38" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification39": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification39" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification4": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification4" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification40": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification40" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification41": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification41" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification5": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification5" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification6": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification6" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification7": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification7" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification8": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification8" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualification9": { "properties": { "id": { "title": "Primary key of the employment qualification.", "description": "Internal ID.", "type": "integer" }, "ranking": { "title": "Ranking within an equivalence network - a linked qualification with a higher or\nequal ranking also satisfies requirements for this qualification.", "type": "integer" }, "equivalent_qualifications": { "title": "Linked (\"equivalent\") qualifications. Kept symmetric by the controller: every link\nA->B is mirrored as B->A, the ranking decides which direction actually covers which.", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentQualification9" } }, "qualification_group": { "title": "L17\/A06: the \"drawer\" this qualification belongs to. Members of one group cover each\nother's requirements within their ranking, like a direct link would.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualificationGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EmploymentQualificationGroup": { "properties": { "id": { "title": "Primary key of the qualification group.", "description": "Internal ID.", "type": "integer" }, "sort_order": { "title": "Order in pickers and legends.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EmploymentQualificationGroup2": { "properties": { "sort_order": { "title": "Order in pickers and legends.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "EuerReport": { "properties": { "id": { "title": "Primary key of the E\u00dcR report.", "description": "Internal ID.", "type": "integer" }, "fiscal_year": { "title": "Gesch\u00e4ftsjahr", "type": "integer" }, "period_start": { "title": "Berichtszeitraum Beginn", "type": "string", "format": "date-time" }, "period_end": { "title": "Berichtszeitraum Ende", "type": "string", "format": "date-time" }, "status": { "title": "Status des Berichts", "type": "string" }, "accounting_method": { "title": "Buchhaltungsmethode (Ist oder Soll)", "type": "string" }, "total_income": { "title": "Gesamteinnahmen (Netto, siehe EuerReportService: Nettomethode)", "type": "number", "format": "float" }, "total_expenses": { "title": "Gesamtausgaben (Netto)", "type": "number", "format": "float" }, "profit": { "title": "Gewinn\/Verlust", "type": "number", "format": "float" }, "deductible_vat": { "title": "Abziehbare Vorsteuer", "type": "number", "format": "float" }, "collected_vat": { "title": "Vereinnahmte Umsatzsteuer", "type": "number", "format": "float" }, "incoming_invoice_count": { "title": "Anzahl enthaltener Eingangsrechnungen", "type": "integer" }, "outgoing_invoice_count": { "title": "Anzahl enthaltener Ausgangsrechnungen", "type": "integer" }, "finalized_at": { "title": "Datum der Finalisierung", "type": "string", "format": "date-time" }, "notes": { "title": "Notizen\/Anmerkungen", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EuerReport2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EventAccessBudget": { "properties": { "id": { "title": "Primary key of the event access budget.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the budget belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "company": { "title": "Company the budget belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "total_budget": { "title": "Total number of sign-ups granted (e.g. 10 for a 10er Karte)", "type": "integer" }, "used_budget": { "title": "Number of sign-ups already consumed", "type": "integer" }, "valid_from": { "title": "Start of the budget period.", "type": "string", "format": "date-time" }, "valid_until": { "title": "End of the budget period.", "type": "string", "format": "date-time" }, "base_event": { "title": "Scope: limit budget to a specific event", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent25" } ] }, "unified_category": { "title": "Scope: limit budget to events of this unified category", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory8" } ] }, "event_type": { "title": "Scope: limit budget to events of this event type (WORKSHOP, CAMP, COURSE, etc.)", "type": "string" }, "source_product": { "title": "The product that created this budget (if purchased)", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem8" } ] }, "source_invoice": { "title": "The invoice whose payment triggered budget creation", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice8" } ] }, "source_invoice_item": { "title": "The invoice item that triggered budget creation (DB-enforced unique, prevents\ncreating a budget twice for the same invoice item).", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceItem" } ] }, "source_person_log_book_entry": { "title": "The person log book entry (role) that triggered budget creation for role-based budgets.", "oneOf": [ { "$ref": "#\/components\/schemas\/PersonLogBookEntry" } ] }, "source_period_start": { "title": "For role-based recurring budgets: the start of the interval period this budget covers\n(e.g. 2024-06-01 for a monthly role budget covering June). Null for once-per-role or\nnon-role budgets. Combined with sourcePersonLogBookEntry + sourceProduct this is unique.", "type": "string", "format": "date-time" }, "source_type": { "title": "How this budget was created: 'purchase', 'bonus', 'manual'", "type": "string" }, "internal_description": { "title": "Internal description of the budget.", "type": "string" }, "trial_policy": { "title": "Rule of a trial pass (sourceType trial)", "oneOf": [ { "$ref": "#\/components\/schemas\/TrialPolicy3" } ] }, "trial_status": { "title": "active, exhausted (all dates used and over), converted (course place or membership),\nexpired (validity over), cancelled (ended by the office)", "type": "string" }, "trial_exhausted_at": { "title": "Time all trial places were used.", "type": "string", "format": "date-time" }, "trial_follow_up_sent_at": { "title": "Time the follow-up after the trial was sent.", "type": "string", "format": "date-time" }, "trial_reminder_sent_at": { "title": "Time the trial reminder was sent.", "type": "string", "format": "date-time" }, "trial_converted_at": { "title": "Time the trial was converted into a membership.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventAccessBudget2": { "type": "object" }, "EventAccessBudget3": { "properties": { "id": { "title": "Primary key of the event access budget.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the budget belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "total_budget": { "title": "Total number of sign-ups granted (e.g. 10 for a 10er Karte)", "type": "integer" }, "used_budget": { "title": "Number of sign-ups already consumed", "type": "integer" }, "valid_from": { "title": "Start of the budget period.", "type": "string", "format": "date-time" }, "valid_until": { "title": "End of the budget period.", "type": "string", "format": "date-time" }, "base_event": { "title": "Scope: limit budget to a specific event", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent25" } ] }, "unified_category": { "title": "Scope: limit budget to events of this unified category", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory" } ] }, "event_type": { "title": "Scope: limit budget to events of this event type (WORKSHOP, CAMP, COURSE, etc.)", "type": "string" }, "source_type": { "title": "How this budget was created: 'purchase', 'bonus', 'manual'", "type": "string" }, "trial_policy": { "title": "Rule of a trial pass (sourceType trial)", "oneOf": [ { "$ref": "#\/components\/schemas\/TrialPolicy4" } ] }, "trial_status": { "title": "active, exhausted (all dates used and over), converted (course place or membership),\nexpired (validity over), cancelled (ended by the office)", "type": "string" }, "trial_exhausted_at": { "title": "Time all trial places were used.", "type": "string", "format": "date-time" }, "trial_follow_up_sent_at": { "title": "Time the follow-up after the trial was sent.", "type": "string", "format": "date-time" }, "trial_reminder_sent_at": { "title": "Time the trial reminder was sent.", "type": "string", "format": "date-time" }, "trial_converted_at": { "title": "Time the trial was converted into a membership.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventAccessBudget4": { "properties": { "id": { "title": "Primary key of the event access budget.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the budget belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "total_budget": { "title": "Total number of sign-ups granted (e.g. 10 for a 10er Karte)", "type": "integer" }, "used_budget": { "title": "Number of sign-ups already consumed", "type": "integer" }, "valid_from": { "title": "Start of the budget period.", "type": "string", "format": "date-time" }, "valid_until": { "title": "End of the budget period.", "type": "string", "format": "date-time" }, "base_event": { "title": "Scope: limit budget to a specific event", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent25" } ] }, "unified_category": { "title": "Scope: limit budget to events of this unified category", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory41" } ] }, "event_type": { "title": "Scope: limit budget to events of this event type (WORKSHOP, CAMP, COURSE, etc.)", "type": "string" }, "source_type": { "title": "How this budget was created: 'purchase', 'bonus', 'manual'", "type": "string" }, "trial_policy": { "title": "Rule of a trial pass (sourceType trial)", "oneOf": [ { "$ref": "#\/components\/schemas\/TrialPolicy6" } ] }, "trial_status": { "title": "active, exhausted (all dates used and over), converted (course place or membership),\nexpired (validity over), cancelled (ended by the office)", "type": "string" }, "trial_exhausted_at": { "title": "Time all trial places were used.", "type": "string", "format": "date-time" }, "trial_follow_up_sent_at": { "title": "Time the follow-up after the trial was sent.", "type": "string", "format": "date-time" }, "trial_reminder_sent_at": { "title": "Time the trial reminder was sent.", "type": "string", "format": "date-time" }, "trial_converted_at": { "title": "Time the trial was converted into a membership.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventBookingSubstitution": { "properties": { "booking_id": { "type": "integer" }, "source_ticket_id": { "type": "integer" }, "source_non_work_time_request_id": { "type": "integer" }, "id": { "title": "Primary key of the substitution.", "description": "Internal ID.", "type": "integer" }, "lock_version": { "title": "Version used to prevent parallel changes to the substitution.", "type": "integer" }, "booking_start": { "title": "Copy of the appointment start: list ordering and filters without a join, and the\nhistory stays readable after the appointment is gone.", "type": "string", "format": "date-time" }, "booking_end": { "title": "End of the booking that needs a substitute.", "type": "string", "format": "date-time" }, "booking_label": { "title": "Name and start of the appointment at creation, for the history.", "type": "string" }, "slot": { "title": "1 = main trainer (performingPerson), 2 = secondary ... 5 = fifth.", "type": "integer" }, "reason": { "title": "Reason for the substitution, for example illness.", "type": "string" }, "state": { "title": "State of the substitution, for example open, claimed or filled.", "type": "string" }, "qualification_match_mode": { "title": "How the qualifications of substitutes are matched.", "type": "string" }, "qualification_source": { "title": "Source of the qualifications used to find substitutes.", "type": "string" }, "filled_via": { "title": "How the substitution was filled, for example by a trainer or by staff.", "type": "string" }, "claimed_at": { "title": "Time the substitution was claimed.", "type": "string", "format": "date-time" }, "filled_at": { "title": "Time the substitution was filled.", "type": "string", "format": "date-time" }, "decided_at": { "title": "Time the substitution was decided.", "type": "string", "format": "date-time" }, "decided_by_username": { "title": "Login name of the person who decided the substitution.", "type": "string" }, "decision_note": { "title": "Note on the decision.", "type": "string" }, "closed_at": { "title": "Time the substitution was closed.", "type": "string", "format": "date-time" }, "notified_at": { "title": "Time the possible substitutes were last notified.", "type": "string", "format": "date-time" }, "notified_count": { "title": "Number of possible substitutes that were notified.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventBookingSubstitutionLog": { "properties": { "substitution_id": { "type": "integer" }, "booking_id": { "type": "integer" }, "id": { "title": "Primary key of the log entry.", "description": "Internal ID.", "type": "integer" }, "booking_label": { "title": "Label of the booking at the time of the entry.", "type": "string" }, "slot": { "title": "Slot of the substitution, for example the position in the list.", "type": "integer" }, "action": { "title": "Action that was logged, for example claimed or filled.", "type": "string" }, "actor_name": { "title": "Name of the acting person or user at the time, or the system user.", "type": "string" }, "channel": { "title": "Channel of the action, for example app or e-mail.", "type": "string" }, "from_state": { "title": "State before the change.", "type": "string" }, "to_state": { "title": "State after the change.", "type": "string" }, "message": { "title": "Message written with the entry.", "type": "string" }, "created": { "title": "Time the entry was logged.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventInventoryLoan": { "properties": { "overdue": { "type": "boolean" }, "deposit_refunded_amount": { "title": "Amount paid back on return (deposit minus the retained part).", "type": "number", "format": "float" }, "id": { "title": "Primary key of the inventory loan.", "description": "Internal ID.", "type": "integer" }, "bookable_name": { "title": "Name of the item at the time of the hand-over.", "type": "string" }, "borrower_name": { "title": "Name of the borrower at the time, or the name typed in for somebody without a person.", "type": "string" }, "quantity": { "title": "Number of items lent out.", "type": "integer" }, "state": { "title": "State of the loan, for example issued or returned.", "type": "string" }, "issued_at": { "title": "Time the item was issued.", "type": "string", "format": "date-time" }, "due_at": { "title": "Time the item is due back.", "type": "string", "format": "date-time" }, "returned_at": { "title": "Time the item was returned.", "type": "string", "format": "date-time" }, "deposit_amount": { "title": "Deposit paid for the loan.", "type": "number", "format": "float" }, "deposit_state": { "title": "State of the deposit, for example held or refunded.", "type": "string" }, "deposit_retained_amount": { "title": "Part of the deposit kept on return.", "type": "number", "format": "float" }, "condition_on_issue": { "title": "Condition of the item when it was issued.", "type": "string" }, "condition_on_return": { "title": "Condition of the item when it was returned.", "type": "string" }, "note": { "title": "Internal note of the office, not shown to the borrower.", "type": "string" }, "issued_by_name": { "title": "Name of the staff member who issued the item.", "type": "string" }, "returned_by_name": { "title": "Name of the staff member who took back the item.", "type": "string" }, "last_reminder_at": { "title": "Last reminder (due soon or overdue) sent to the borrower.", "type": "string", "format": "date-time" }, "reminder_count": { "title": "Number of reminders sent for the loan.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventInventoryLoan2": { "properties": { "overdue": { "type": "boolean" }, "deposit_refunded_amount": { "title": "Amount paid back on return (deposit minus the retained part).", "type": "number", "format": "float" }, "id": { "title": "Primary key of the inventory loan.", "description": "Internal ID.", "type": "integer" }, "bookable_name": { "title": "Name of the item at the time of the hand-over.", "type": "string" }, "borrower_name": { "title": "Name of the borrower at the time, or the name typed in for somebody without a person.", "type": "string" }, "quantity": { "title": "Number of items lent out.", "type": "integer" }, "state": { "title": "State of the loan, for example issued or returned.", "type": "string" }, "issued_at": { "title": "Time the item was issued.", "type": "string", "format": "date-time" }, "due_at": { "title": "Time the item is due back.", "type": "string", "format": "date-time" }, "returned_at": { "title": "Time the item was returned.", "type": "string", "format": "date-time" }, "deposit_amount": { "title": "Deposit paid for the loan.", "type": "number", "format": "float" }, "deposit_state": { "title": "State of the deposit, for example held or refunded.", "type": "string" }, "deposit_retained_amount": { "title": "Part of the deposit kept on return.", "type": "number", "format": "float" }, "condition_on_issue": { "title": "Condition of the item when it was issued.", "type": "string" }, "condition_on_return": { "title": "Condition of the item when it was returned.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventMoment": { "properties": { "has_file": { "title": "Virtual serializer property: does this moment have a downloadable file?", "type": "boolean" }, "file_virus_checked": { "title": "Virtual serializer property for the organizer: has the file passed the\nbackground virus scan? Null without a file. The organizer list uses this to\nsay \"still being checked\" instead of showing a preview that answers 404.", "description": "Not part of the guest groups on purpose - a guest sees only own files, and\nthose are handed out regardless of the scan state.", "type": "boolean" }, "id": { "title": "Primary key of the event moment.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Hard-to-guess identifier; used as the public identifier of the moment\nso numeric ids are never exposed to guests.", "type": "string" }, "moment_type": { "title": "Type of the moment, for example photo or video.", "type": "string" }, "moderation_status": { "title": "Moderation status of the moment, for example pending or approved.", "type": "string" }, "sign_up": { "title": "Optional participant reference; null for anonymous contributions\nvia the anonymous event moments token.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp17" } ] }, "guest_name": { "title": "Optional display name entered by the guest.", "type": "string" }, "duration_seconds": { "title": "Audio\/video duration in seconds (client-provided, informational).", "type": "integer" }, "consent_confirmed": { "title": "GDPR: guest confirmed the consent text before submitting.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EventScoreboardActivity": { "properties": { "base_event_id": { "type": "integer" }, "id": { "title": "Primary key of the scoreboard activity.", "description": "Internal ID.", "type": "integer" }, "activity_type": { "title": "Type of the activity, for example goal, penalty or time-out.", "type": "string" }, "side": { "title": "HOME, AWAY or null (phase changes, notes).", "type": "string" }, "points": { "title": "Points of a SCORE entry (1 for a goal, 1\/2\/3 in basketball).", "type": "integer" }, "minute": { "title": "Match minute, as entered.", "type": "integer" }, "period": { "title": "Period (half, quarter, set) the entry belongs to; set from the match state when empty.", "type": "integer" }, "player_name": { "title": "Name of the player the activity belongs to.", "type": "string" }, "player_number": { "title": "Jersey number.", "type": "string" }, "duration_minutes": { "title": "Suspension length in minutes (SUSPENSION, e.g. 2).", "type": "integer" }, "note": { "title": "Note on the activity.", "type": "string" }, "created_by_name": { "title": "Who entered the entry (admin user or trainer), shown in the admin app only.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventScoreboardActivity2": { "properties": { "activity_type": { "title": "Type of the activity, for example goal, penalty or time-out.", "type": "string" }, "side": { "title": "HOME, AWAY or null (phase changes, notes).", "type": "string" }, "points": { "title": "Points of a SCORE entry (1 for a goal, 1\/2\/3 in basketball).", "type": "integer" }, "minute": { "title": "Match minute, as entered.", "type": "integer" }, "period": { "title": "Period (half, quarter, set) the entry belongs to; set from the match state when empty.", "type": "integer" }, "player_name": { "title": "Name of the player the activity belongs to.", "type": "string" }, "player_number": { "title": "Jersey number.", "type": "string" }, "duration_minutes": { "title": "Suspension length in minutes (SUSPENSION, e.g. 2).", "type": "integer" }, "note": { "title": "Note on the activity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EventSignUpCopyToBookingsResult": { "properties": { "copied": { "type": "integer" }, "skipped_existing": { "type": "integer" }, "skipped_full": { "type": "integer" }, "skipped_other": { "type": "integer" }, "bookings_processed": { "type": "integer" } }, "type": "object" }, "EventSignUpMembershipAssignType": { "required": [ "signUpIds" ], "properties": { "signUpIds": { "type": "array", "items": { "type": "integer" } }, "productForMembers": { "type": "string", "format": "Inwendo\\BillingBundle\\Entity\\PredefinedBillingItem id" }, "productForNonMembers": { "type": "string", "format": "Inwendo\\BillingBundle\\Entity\\PredefinedBillingItem id" }, "contentType": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "billingProfile": { "type": "string", "format": "Inwendo\\BillingBundle\\Entity\\BillingPaymentProfile id" }, "unifiedCategory": { "type": "string", "format": "Inwendo\\CRMBundle\\Entity\\UnifiedCategory id" }, "createAsSubscription": { "type": "boolean" }, "dryRun": { "type": "boolean" } }, "type": "object" }, "EventTimingDevice": { "properties": { "base_event_id": { "type": "integer" }, "timing_point_id": { "type": "integer" }, "id": { "title": "Primary key of the timing device.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the timing device.", "type": "string" }, "device_type": { "title": "Type of the timing device, for example chip reader or app.", "type": "string" }, "active": { "title": "The device is active.", "type": "boolean" }, "last_seen_at": { "title": "Time the device was last seen.", "type": "string", "format": "date-time" }, "clock_offset_ms": { "title": "Server time minus device time in ms, measured at the last heartbeat.", "type": "integer" }, "battery_level": { "title": "Battery level of the device in percent.", "type": "integer" }, "firmware": { "title": "Firmware version of the device.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventTimingDevice2": { "properties": { "name": { "title": "Name of the timing device.", "type": "string" }, "device_type": { "title": "Type of the timing device, for example chip reader or app.", "type": "string" }, "active": { "title": "The device is active.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EventTimingDevice3": { "properties": { "base_event_id": { "type": "integer" }, "timing_point_id": { "type": "integer" }, "id": { "title": "Primary key of the timing device.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the timing device.", "type": "string" }, "device_type": { "title": "Type of the timing device, for example chip reader or app.", "type": "string" }, "active": { "title": "The device is active.", "type": "boolean" }, "token": { "title": "Secret of the device, only serialized in the detail view.", "type": "string" }, "last_seen_at": { "title": "Time the device was last seen.", "type": "string", "format": "date-time" }, "clock_offset_ms": { "title": "Server time minus device time in ms, measured at the last heartbeat.", "type": "integer" }, "battery_level": { "title": "Battery level of the device in percent.", "type": "integer" }, "firmware": { "title": "Firmware version of the device.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventTimingPoint": { "properties": { "base_event_id": { "type": "integer" }, "id": { "title": "Primary key of the timing point.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the timing point, for example start or finish.", "type": "string" }, "point_type": { "title": "Type of the timing point.", "type": "string" }, "distance_meters": { "title": "Distance from the start in meters.", "type": "integer" }, "latitude": { "title": "Latitude of the point in degrees.", "type": "number", "format": "float" }, "longitude": { "title": "Longitude of the point in degrees.", "type": "number", "format": "float" }, "sort_order": { "title": "Sort order of the timing points.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventTimingPoint2": { "properties": { "name": { "title": "Name of the timing point, for example start or finish.", "type": "string" }, "point_type": { "title": "Type of the timing point.", "type": "string" }, "distance_meters": { "title": "Distance from the start in meters.", "type": "integer" }, "latitude": { "title": "Latitude of the point in degrees.", "type": "number", "format": "float" }, "longitude": { "title": "Longitude of the point in degrees.", "type": "number", "format": "float" }, "sort_order": { "title": "Sort order of the timing points.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "EventTimingRead": { "properties": { "base_event_id": { "type": "integer" }, "timing_point_id": { "type": "integer" }, "sign_up_id": { "type": "integer" }, "bib_label": { "type": "string" }, "name": { "type": "string" }, "device_id": { "type": "integer" }, "read_time_ms": { "title": "Unix time in milliseconds (device clock corrected by its offset).", "type": "integer" }, "id": { "title": "Primary key of the timing read.", "description": "Internal ID.", "type": "integer" }, "raw_bib": { "title": "Bib number as read by the device.", "type": "string" }, "raw_chip": { "title": "Chip ID as read by the device.", "type": "string" }, "read_time": { "title": "Time of the read.", "type": "string", "format": "date-time" }, "source": { "title": "Source of the read, for example device or manual entry.", "type": "string" }, "external_id": { "title": "Id of the read at its source (device sequence number, CSV row), used for idempotency.", "type": "string" }, "status": { "title": "Status of the read, for example matched or unknown.", "type": "string" }, "latitude": { "title": "Latitude of the read in degrees, if known.", "type": "number", "format": "float" }, "longitude": { "title": "Longitude of the read in degrees, if known.", "type": "number", "format": "float" }, "accuracy": { "title": "Accuracy of the position in meters.", "type": "number", "format": "float" }, "note": { "title": "Note on the read.", "type": "string" }, "created": { "title": "Time the read was stored.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventTimingResult": { "properties": { "base_event_id": { "type": "integer" }, "sign_up_id": { "type": "integer" }, "bib_label": { "type": "string" }, "name": { "type": "string" }, "start_time_ms": { "title": "Start time in milliseconds.", "type": "integer" }, "finish_time_ms": { "title": "Finish time in milliseconds.", "type": "integer" }, "last_timing_point_id": { "type": "integer" }, "last_read_time_ms": { "title": "Time of the last read in milliseconds.", "type": "integer" }, "id": { "title": "Primary key of the timing result.", "description": "Internal ID.", "type": "integer" }, "status": { "title": "Status of the result, for example finished, dnf or dsq.", "type": "string" }, "status_manual": { "title": "The status was set manually and is not recalculated.", "type": "boolean" }, "gross_time_ms": { "title": "Gross time in milliseconds, including breaks.", "type": "integer" }, "net_time_ms": { "title": "Net time in milliseconds, without breaks.", "type": "integer" }, "rank_overall": { "title": "Overall rank of the participant.", "type": "integer" }, "rank_gender": { "title": "Rank of the participant within the gender.", "type": "integer" }, "rank_age_class": { "title": "Rank of the participant within the age class.", "type": "integer" }, "age_class": { "title": "Age class of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant used for the ranking.", "type": "string" }, "note": { "title": "Note on the result.", "type": "string" }, "calculated": { "title": "Time the result was calculated.", "type": "string", "format": "date-time" } }, "type": "object" }, "EventTimingResult2": { "properties": { "status": { "title": "Status of the result, for example finished, dnf or dsq.", "type": "string" }, "status_manual": { "title": "The status was set manually and is not recalculated.", "type": "boolean" }, "note": { "title": "Note on the result.", "type": "string" } }, "type": "object" }, "ExpenseCategory": { "properties": { "id": { "title": "Primary key of the expense category.", "description": "Internal ID.", "type": "integer" }, "code": { "title": "Kurzbezeichnung\/Code (z.B. \"WAREN\", \"PERSONAL\", \"MIETE\")", "type": "string" }, "eur_line_number": { "title": "Zeile in der Anlage E\u00dcR (z.B. 23 f\u00fcr Wareneinkauf)", "type": "integer" }, "eur_line_name": { "title": "Bezeichnung der E\u00dcR-Zeile (z.B. \"Waren, Rohstoffe und Hilfsstoffe\")", "type": "string" }, "category_type": { "title": "Typ der Kategorie (expense, income, neutral, asset, private)", "type": "string" }, "parent": { "title": "\u00dcbergeordnete Kategorie (f\u00fcr Hierarchie)", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory" } ] }, "children": { "title": "Untergeordnete Kategorien", "type": "array", "items": { "$ref": "#\/components\/schemas\/ExpenseCategory" } }, "default_tax": { "title": "Standard-Steuersatz f\u00fcr diese Kategorie", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "cost_center": { "title": "Kostenstelle der Kategorie - bei Vereinen die steuerliche Sph\u00e4re.", "description": "Ein Beleg tr\u00e4gt keine eigene Sph\u00e4re; \u00fcber seine Kategorie bekommt er\neine. Die E\u00dcR des wirtschaftlichen Gesch\u00e4ftsbetriebs liest sie\n(billing_euer_commercial_sphere_only), die automatische Buchung setzt\nsie auf die Buchungszeilen (billing_accounting_cost_center_from_category).", "oneOf": [ { "$ref": "#\/components\/schemas\/CostCenter" } ] }, "is_vat_deductible": { "title": "Ist Vorsteuerabzug m\u00f6glich?", "type": "boolean" }, "is_immediate_deduction": { "title": "Ist die Kategorie sofort abzugsf\u00e4hig? (vs. Abschreibung \u00fcber mehrere Jahre)", "type": "boolean" }, "depreciation_years": { "title": "Abschreibungsdauer in Jahren (f\u00fcr Anlageverm\u00f6gen)", "type": "integer" }, "sort_order": { "title": "Sortierreihenfolge", "type": "integer" }, "is_active": { "title": "Ist die Kategorie aktiv\/sichtbar?", "type": "boolean" }, "color": { "title": "Farbe f\u00fcr UI-Darstellung (Hex-Code)", "type": "string" }, "icon": { "title": "Icon-Name f\u00fcr UI-Darstellung", "type": "string" }, "is_system": { "title": "Ist dies eine System-Kategorie? (nicht l\u00f6schbar)", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ExpenseCategory10": { "properties": { "id": { "title": "Primary key of the expense category.", "description": "Internal ID.", "type": "integer" }, "code": { "title": "Kurzbezeichnung\/Code (z.B. \"WAREN\", \"PERSONAL\", \"MIETE\")", "type": "string" }, "eur_line_number": { "title": "Zeile in der Anlage E\u00dcR (z.B. 23 f\u00fcr Wareneinkauf)", "type": "integer" }, "eur_line_name": { "title": "Bezeichnung der E\u00dcR-Zeile (z.B. \"Waren, Rohstoffe und Hilfsstoffe\")", "type": "string" }, "category_type": { "title": "Typ der Kategorie (expense, income, neutral, asset, private)", "type": "string" }, "default_tax": { "title": "Standard-Steuersatz f\u00fcr diese Kategorie", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "cost_center": { "title": "Kostenstelle der Kategorie - bei Vereinen die steuerliche Sph\u00e4re.", "description": "Ein Beleg tr\u00e4gt keine eigene Sph\u00e4re; \u00fcber seine Kategorie bekommt er\neine. Die E\u00dcR des wirtschaftlichen Gesch\u00e4ftsbetriebs liest sie\n(billing_euer_commercial_sphere_only), die automatische Buchung setzt\nsie auf die Buchungszeilen (billing_accounting_cost_center_from_category).", "oneOf": [ { "$ref": "#\/components\/schemas\/CostCenter" } ] }, "is_vat_deductible": { "title": "Ist Vorsteuerabzug m\u00f6glich?", "type": "boolean" }, "is_immediate_deduction": { "title": "Ist die Kategorie sofort abzugsf\u00e4hig? (vs. Abschreibung \u00fcber mehrere Jahre)", "type": "boolean" }, "depreciation_years": { "title": "Abschreibungsdauer in Jahren (f\u00fcr Anlageverm\u00f6gen)", "type": "integer" }, "sort_order": { "title": "Sortierreihenfolge", "type": "integer" }, "is_active": { "title": "Ist die Kategorie aktiv\/sichtbar?", "type": "boolean" }, "color": { "title": "Farbe f\u00fcr UI-Darstellung (Hex-Code)", "type": "string" }, "icon": { "title": "Icon-Name f\u00fcr UI-Darstellung", "type": "string" }, "is_system": { "title": "Ist dies eine System-Kategorie? (nicht l\u00f6schbar)", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ExternalDisplay": { "properties": { "id": { "title": "Primary key of the external display.", "description": "Internal ID.", "type": "integer" }, "device_type": { "title": "Which kind of device this is, and therefore which driver renders for it.", "description": "Today only the built-in e-paper renderer exists; a third-party display API\nbecomes an additional type plus an additional driver, nothing else.", "type": "string" }, "device_id": { "title": "Public identifier of the device, travelling in the request path.", "description": "Deliberately not the secret: paths end up in access logs, proxy logs and\nsupport screenshots. Keeping an id there lets a device be identified in a\nlog without the credential riding along.", "type": "string" }, "previous_secret_valid_until": { "title": "Time until the previous secret of the display is still accepted.", "type": "string", "format": "date-time" }, "base_bookable": { "title": "Bookable the display shows.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookable16" } ] }, "base_location": { "title": "Location the display is placed at.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "content_profile": { "title": "How much this particular sign is allowed to say.", "description": "A door sign is a publicly visible output channel: that the renderer may\nread the data does not mean the sign may show it. The profile sits on the\ndisplay, not on the room, because the same room can carry a hallway sign\nand a staff-side sign.", "type": "string" }, "language": { "title": "Language every word on this frame is rendered in.", "description": "Sits on the display, not on the installation: a foyer board in a bilingual\nbuilding can want English while the door signs behind it stay German.", "type": "string" }, "show_booking_qr": { "title": "Show a booking QR code when the bookable is free.", "description": "Only honoured when the bookable actually accepts self-service bookings -\na code that leads nowhere is worse than no code.", "type": "boolean" }, "notice_text": { "title": "Free-text notice, rendered as a footer line.", "type": "string" }, "refresh_seconds": { "title": "Baseline for the X-Refresh-After header, in seconds. The renderer shortens\nit when something happens sooner and never exceeds it by much.", "type": "integer" }, "last_seen_at": { "title": "Last successful fetch by the device.", "description": "No log table on purpose: a display checks in every few minutes, which is\nroughly 288 rows per device per day, and only the last one is ever read.", "type": "string", "format": "date-time" }, "battery_voltage": { "title": "Battery voltage of the display in volts.", "type": "number", "format": "float" }, "battery_warn_voltage": { "title": "Battery voltage below which this display counts as needing a new battery.", "description": "Per display because the hardware differs by a factor of two: a LiPo door\nsign is flat around 3.5 V, a coin cell OpenDisplay tag around 2.4 V. Empty\nmeans the installation-wide default (event_external_display_battery_warn_voltage).", "type": "number", "format": "float" }, "battery_warning_sent_at": { "title": "When the health check found the battery below the threshold. Cleared once\na reading is clearly above it again, so a replaced battery re-arms the\nwarning. This is the display's maintenance flag as much as a send marker:\nit is set even when no recipient is configured.", "type": "string", "format": "date-time" }, "offline_warning_sent_at": { "title": "When the health check found the display silent for too long. Cleared by\nthe next fetch of the device.", "type": "string", "format": "date-time" }, "firmware_version": { "title": "Firmware version of the display.", "type": "string" }, "rssi": { "title": "Signal strength of the display in dBm.", "type": "integer" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ExternalDisplay2": { "properties": { "device_type": { "title": "Which kind of device this is, and therefore which driver renders for it.", "description": "Today only the built-in e-paper renderer exists; a third-party display API\nbecomes an additional type plus an additional driver, nothing else.", "type": "string" }, "base_bookable": { "title": "Bookable the display shows.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookable17" } ] }, "base_location": { "title": "Location the display is placed at.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation6" } ] }, "content_profile": { "title": "How much this particular sign is allowed to say.", "description": "A door sign is a publicly visible output channel: that the renderer may\nread the data does not mean the sign may show it. The profile sits on the\ndisplay, not on the room, because the same room can carry a hallway sign\nand a staff-side sign.", "type": "string" }, "language": { "title": "Language every word on this frame is rendered in.", "description": "Sits on the display, not on the installation: a foyer board in a bilingual\nbuilding can want English while the door signs behind it stay German.", "type": "string" }, "show_booking_qr": { "title": "Show a booking QR code when the bookable is free.", "description": "Only honoured when the bookable actually accepts self-service bookings -\na code that leads nowhere is worse than no code.", "type": "boolean" }, "notice_text": { "title": "Free-text notice, rendered as a footer line.", "type": "string" }, "refresh_seconds": { "title": "Baseline for the X-Refresh-After header, in seconds. The renderer shortens\nit when something happens sooner and never exceeds it by much.", "type": "integer" }, "battery_warn_voltage": { "title": "Battery voltage below which this display counts as needing a new battery.", "description": "Per display because the hardware differs by a factor of two: a LiPo door\nsign is flat around 3.5 V, a coin cell OpenDisplay tag around 2.4 V. Empty\nmeans the installation-wide default (event_external_display_battery_warn_voltage).", "type": "number", "format": "float" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "FiscalYear": { "properties": { "id": { "title": "Primary key of the fiscal year.", "description": "Internal ID.", "type": "integer" }, "start_date": { "title": "Start date of the fiscal year.", "type": "string", "format": "date-time" }, "end_date": { "title": "End date of the fiscal year.", "type": "string", "format": "date-time" }, "status": { "title": "Status of the fiscal year, for example open or closed.", "type": "string" }, "opening_balance_entered": { "title": "Ob die Er\u00f6ffnungsbilanzwerte erfasst sind.", "description": "Beim ersten Gesch\u00e4ftsjahr einer Installation - oder beim Wechsel von der\nE\u00dcR zur Bilanzierung - m\u00fcssen die Anfangsbest\u00e4nde einmalig eingebucht\nwerden, sonst stimmt die Bilanz nicht.", "type": "boolean" }, "closed_at": { "title": "Time the fiscal year was closed.", "type": "string", "format": "date-time" }, "closed_by": { "title": "Login user who closed the fiscal year.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "closing_entry": { "title": "Die Abschlussbuchung dieses Jahres.", "description": "Ohne diesen Verweis war der vorl\u00e4ufige Abschluss eine Sackgasse: das\nWieder\u00f6ffnen setzte den Status zur\u00fcck, die Buchung blieb stehen, und der\nendg\u00fcltige Abschluss fand keine Salden mehr vor. Mit dem Verweis l\u00e4sst\nsich die Buchung beim Wieder\u00f6ffnen stornieren und der Abschluss beliebig\noft wiederholen.", "oneOf": [ { "$ref": "#\/components\/schemas\/JournalEntry" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "FixedAsset": { "properties": { "id": { "title": "Primary key of the fixed asset.", "description": "Internal ID.", "type": "integer" }, "inventory_number": { "title": "Inventarnummer - frei vergeben, aber f\u00fcr die Inventur unverzichtbar.", "type": "string" }, "acquisition_date": { "title": "Tag der Anschaffung oder Herstellung.", "description": "Bestimmt den Beginn der Abschreibung und den Zeitanteil im ersten Jahr:\nabgeschrieben wird ab dem Anschaffungsmonat, angefangene Monate z\u00e4hlen\nvoll (\u00a7 7 Abs. 1 Satz 4 EStG).", "type": "string", "format": "date-time" }, "acquisition_cost": { "title": "Anschaffungs- oder Herstellungskosten.", "description": "Netto, soweit die Vorsteuer abziehbar ist. Ist sie das nicht - im\nideellen Bereich eines Vereins etwa -, geh\u00f6rt sie zu den\nAnschaffungskosten und erh\u00f6ht damit die Bemessungsgrundlage.", "type": "number", "format": "float" }, "useful_life_months": { "title": "Betriebsgew\u00f6hnliche Nutzungsdauer in Monaten.", "description": "In Monaten statt in Jahren, weil die Abschreibung monatsgenau l\u00e4uft und\nes Nutzungsdauern unter einem Jahr gibt.", "type": "integer" }, "depreciation_method": { "title": "Method of depreciation, for example linear.", "type": "string" }, "ledger_account": { "title": "Aktivkonto, auf dem das Gut steht - SKR04 0630 etwa.", "oneOf": [ { "$ref": "#\/components\/schemas\/LedgerAccount" } ] }, "depreciation_account": { "title": "Aufwandskonto der Abschreibung - SKR04 6220 etwa.", "oneOf": [ { "$ref": "#\/components\/schemas\/LedgerAccount" } ] }, "cost_center": { "title": "Die steuerliche Sph\u00e4re, der das Gut dient.", "oneOf": [ { "$ref": "#\/components\/schemas\/CostCenter" } ] }, "expense_category": { "title": "Die E\u00dcR-Kategorie der Abschreibung.", "description": "Dieselbe Br\u00fccke wie am Sachkonto: wer die E\u00dcR f\u00fchrt, bekommt seine\nZeile in der Anlage E\u00dcR, ohne dass es einen Kontenrahmen br\u00e4uchte.", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "incoming_invoice": { "title": "Der Beleg, aus dem das Gut entstanden ist.", "oneOf": [ { "$ref": "#\/components\/schemas\/IncomingInvoice3" } ] }, "disposal_date": { "title": "Tag des Abgangs - Verkauf, Verschrottung, Entnahme.", "type": "string", "format": "date-time" }, "disposal_proceeds": { "title": "Verkaufserl\u00f6s beim Abgang, netto.", "type": "number", "format": "float" }, "disposal_tax_rate": { "title": "Umsatzsteuersatz auf den Verkaufserl\u00f6s, in Prozent.", "description": "Der Verkauf eines Anlageguts ist ein steuerpflichtiger Umsatz wie jeder\nandere - vorher wurde der Erl\u00f6s netto ohne Steuer gebucht, und die\nUmsatzsteuer fehlte in Bilanz und Voranmeldung.\n\nBewusst ohne Vorgabewert: ob Steuer anf\u00e4llt, h\u00e4ngt am Vorgang. Eine\nVerschrottung, eine Entnahme und der Verkauf aus dem ideellen Bereich\neines Vereins sind steuerfrei; der gewerbliche Verkauf ist es nicht.\nEin geratener Satz w\u00e4re in der H\u00e4lfte der F\u00e4lle falsch.", "type": "number", "format": "float" }, "is_movable": { "title": "Bewegliches Wirtschaftsgut?", "description": "Die degressive AfA des \u00a7 7 Abs. 2 EStG gilt nur fuer bewegliche\nWirtschaftsgueter des Anlagevermoegens - ein Gebaeude oder eine\nSoftware degressiv abzuschreiben ist unzulaessig, und ohne dieses\nMerkmal konnte es niemand verhindern. Vorgabe true: Betriebs- und\nGeschaeftsausstattung ist in diesem System der Regelfall.", "type": "boolean" }, "disposal_reason": { "title": "Reason the asset was disposed of.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "FlexibleLatexTemplate": { "properties": { "predefined": { "title": "True for templates shipped by the servercontrolpanel (PredefinedFlexibleTemplateMap). Their IDs\nare referenced by code, so the UI offers to duplicate (\"Vorlage anpassen\") instead of editing them.", "type": "boolean" }, "data_type": { "title": "Data type (reference class key) the template is rendered and checked with. For predefined\ntemplates (tag IW_PFLT) this is the data type of the code that uses them.", "type": "string" }, "data_type_label": { "title": "Human readable name of the assigned data type, null for tags that are not a known data type.", "type": "string" }, "template_mode": { "title": "Serialized mode so clients do not have to know that null means standard.", "type": "string" }, "last_check_status": { "title": "Summary of the last template check for list views, the full result is admin detail only.", "type": "string" }, "id": { "title": "Primary key of the template.", "description": "Internal ID. Used as a string identifier.", "type": "string" }, "name": { "title": "Name of the template.", "type": "string" }, "tag": { "title": "Tag used to group templates.", "type": "string" }, "mass_message": { "title": "Whether the template is used for mass messages.", "type": "boolean" }, "default_store_as_pdf": { "title": "Whether the generated document is stored as PDF by default.", "type": "boolean" }, "security_scope": { "title": "Scope that controls who can use the template.", "type": "string" }, "security_user_access_type": { "title": "Access type required to use the template.", "type": "integer" }, "param1": { "title": "Value of parameter 1 used in the template.", "type": "string" }, "param2": { "title": "Value of parameter 2 used in the template.", "type": "string" }, "param3": { "title": "Value of parameter 3 used in the template.", "type": "string" }, "param4": { "title": "Value of parameter 4 used in the template.", "type": "string" }, "param5": { "title": "Value of parameter 5 used in the template.", "type": "string" }, "param6": { "title": "Value of parameter 6 used in the template.", "type": "string" }, "param7": { "title": "Value of parameter 7 used in the template.", "type": "string" }, "param8": { "title": "Value of parameter 8 used in the template.", "type": "string" }, "param9": { "title": "Value of parameter 9 used in the template.", "type": "string" }, "param10": { "title": "Value of parameter 10 used in the template.", "type": "string" }, "default_value_param1": { "title": "Default value of parameter 1.", "type": "string" }, "default_value_param2": { "title": "Default value of parameter 2.", "type": "string" }, "default_value_param3": { "title": "Default value of parameter 3.", "type": "string" }, "default_value_param4": { "title": "Default value of parameter 4.", "type": "string" }, "default_value_param5": { "title": "Default value of parameter 5.", "type": "string" }, "default_value_param6": { "title": "Default value of parameter 6.", "type": "string" }, "default_value_param7": { "title": "Default value of parameter 7.", "type": "string" }, "default_value_param8": { "title": "Default value of parameter 8.", "type": "string" }, "default_value_param9": { "title": "Default value of parameter 9.", "type": "string" }, "default_value_param10": { "title": "Default value of parameter 10.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "FlexibleLatexTemplate3": { "type": "object" }, "FormLoginUser": { "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "FormLoginUser2": { "properties": { "username": { "type": "string" } }, "type": "object" }, "FormLoginUser3": { "properties": { "code": { "title": "Code of the login form user.", "type": "string" }, "type": { "title": "Type of the login form user.", "type": "string", "nullable": true }, "client_id": { "title": "Identifier of the client the login form belongs to.", "type": "string", "nullable": true } }, "type": "object" }, "FormSession": { "properties": { "sessionid": { "type": "string" } }, "type": "object" }, "FormStartCall": { "properties": {}, "type": "object" }, "GeneralMeeting": { "properties": { "id": { "title": "Primary key of the general meeting.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the general meeting.", "type": "string" }, "agenda": { "title": "Agenda (Tagesordnung) as plain text, one item per line.", "type": "string" }, "meeting_type": { "title": "Type of the meeting, for example ordinary or extraordinary.", "type": "string" }, "state": { "title": "State of the meeting, for example planned, running or closed.", "type": "string" }, "start": { "title": "Start of the meeting.", "type": "string", "format": "date-time" }, "end": { "title": "End of the meeting.", "type": "string", "format": "date-time" }, "location": { "title": "Location of the meeting.", "type": "string" }, "online_url": { "title": "Link of the video conference for online and hybrid meetings.", "type": "string" }, "invited_at": { "title": "Time the invitations were sent.", "type": "string", "format": "date-time" }, "invitation_late": { "title": "True when the invitation went out after the notice period and the office confirmed it.", "type": "boolean" }, "started_at": { "title": "Time the meeting started.", "type": "string", "format": "date-time" }, "closed_at": { "title": "Time the meeting was closed.", "type": "string", "format": "date-time" }, "minutes": { "title": "Minutes of the meeting.", "type": "string" }, "minutes_finalized_at": { "title": "Time the minutes were finalized.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "GeneralMeetingMotion": { "properties": { "meeting_id": { "type": "integer" }, "ballot_count": { "title": "Ballots cast through the app so far; set by the controller, never the choices of an open vote.", "type": "integer" }, "id": { "title": "Primary key of the motion.", "description": "Internal ID.", "type": "integer" }, "position": { "title": "Position of the motion in the agenda.", "type": "integer" }, "title": { "title": "Title of the motion.", "type": "string" }, "description": { "title": "Text of the motion.", "type": "string" }, "voting_mode": { "title": "Voting mode, for example open or secret.", "type": "string" }, "majority": { "title": "Majority needed to accept the motion, for example simple or two-thirds.", "type": "string" }, "state": { "title": "State of the motion, for example open, voting or closed.", "type": "string" }, "opened_at": { "title": "Time the voting was opened.", "type": "string", "format": "date-time" }, "closed_at": { "title": "Time the voting was closed.", "type": "string", "format": "date-time" }, "manual_yes": { "title": "Votes counted on site (show of hands), added to the app votes when closing.", "type": "integer" }, "manual_no": { "title": "Number of manual no votes.", "type": "integer" }, "manual_abstain": { "title": "Number of manual abstentions.", "type": "integer" }, "yes_count": { "title": "Final counts (app + manual), set when closing.", "type": "integer" }, "no_count": { "title": "Number of no votes.", "type": "integer" }, "abstain_count": { "title": "Number of abstentions.", "type": "integer" }, "present_voting_count": { "title": "Entitled voters present when closing; the base of an ABSOLUTE majority.", "type": "integer" }, "result": { "title": "Result of the vote, for example accepted or rejected.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "GeneralMeetingParticipant": { "properties": { "meeting_id": { "type": "integer" }, "id": { "title": "Primary key of the meeting participant.", "description": "Internal ID.", "type": "integer" }, "voting_right": { "title": "The participant has a voting right.", "type": "boolean" }, "voting_right_reason": { "title": "NO_VOTE_* when the person has no voting right, null otherwise.", "type": "string" }, "voting_right_manual": { "title": "The office set the voting right by hand; a recalculation keeps it.", "type": "boolean" }, "invited_at": { "title": "Time the participant was invited.", "type": "string", "format": "date-time" }, "response": { "title": "Response to the invitation, for example accepted or declined.", "type": "string" }, "responded_at": { "title": "Time the response was given.", "type": "string", "format": "date-time" }, "attendance": { "title": "Attendance of the participant, for example present or excused.", "type": "string" }, "checked_in_at": { "title": "Time the participant checked in.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "GradeLevelUpdateRequest": { "type": "object" }, "GradeLevelUpdateRequest2": { "properties": {}, "type": "object" }, "HbciBankData": { "properties": { "id": { "title": "Primary key of the bank data.", "description": "Internal ID.", "type": "integer" }, "blz": { "title": "Bank code (BLZ) of the bank.", "type": "string" }, "bic": { "title": "BIC of the bank.", "type": "string" }, "institute_name": { "title": "Name of the bank institute.", "type": "string" }, "city": { "title": "City of the bank institute.", "type": "string" }, "organization": { "title": "Organization of the bank for FinTS.", "type": "string" }, "hbci_url": { "title": "URL of the FinTS server.", "type": "string" }, "pin_tan_url": { "title": "URL of the PIN\/TAN service.", "type": "string" }, "fints_version": { "title": "FinTS version supported by the bank.", "type": "string" } }, "type": "object" }, "HbciCredential": { "properties": { "id": { "title": "Primary key of the HBCI credential.", "description": "Internal ID.", "type": "integer" }, "billing_payout_account": { "title": "Payout account the credential belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingPayoutAccount3" } ] }, "bank_data": { "title": "Bank data of the credential.", "oneOf": [ { "$ref": "#\/components\/schemas\/HbciBankData" } ] }, "enabled": { "title": "The credential is enabled.", "type": "boolean" }, "username": { "title": "Login name at the bank.", "type": "string" }, "tan_mode_id": { "title": "ID of the TAN mode selected at the bank.", "type": "integer" }, "tan_mode_name": { "title": "Name of the TAN mode.", "type": "string" }, "tan_medium_name": { "title": "Name of the TAN medium.", "type": "string" }, "bpd_cache_updated": { "title": "Time the bank parameter data was updated.", "type": "string", "format": "date-time" }, "last_sync": { "title": "Time of the last synchronization.", "type": "string", "format": "date-time" }, "last_sync_error": { "title": "Error of the last synchronization.", "type": "string" }, "auto_import_enabled": { "title": "Automatic import of bank transactions is enabled.", "type": "boolean" }, "last_auto_import_at": { "title": "Time of the last automatic import.", "type": "string", "format": "date-time" }, "auto_import_status": { "title": "Status of the last automatic import.", "type": "string" }, "auto_import_message": { "title": "Message of the last automatic import.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "HbciCredential2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "HbciCredential3": { "properties": { "id": { "title": "Primary key of the HBCI credential.", "description": "Internal ID.", "type": "integer" }, "bank_data": { "title": "Bank data of the credential.", "oneOf": [ { "$ref": "#\/components\/schemas\/HbciBankData" } ] }, "enabled": { "title": "The credential is enabled.", "type": "boolean" }, "username": { "title": "Login name at the bank.", "type": "string" }, "tan_mode_id": { "title": "ID of the TAN mode selected at the bank.", "type": "integer" }, "tan_mode_name": { "title": "Name of the TAN mode.", "type": "string" }, "tan_medium_name": { "title": "Name of the TAN medium.", "type": "string" }, "last_sync": { "title": "Time of the last synchronization.", "type": "string", "format": "date-time" }, "last_sync_error": { "title": "Error of the last synchronization.", "type": "string" }, "auto_import_enabled": { "title": "Automatic import of bank transactions is enabled.", "type": "boolean" }, "last_auto_import_at": { "title": "Time of the last automatic import.", "type": "string", "format": "date-time" }, "auto_import_status": { "title": "Status of the last automatic import.", "type": "string" }, "auto_import_message": { "title": "Message of the last automatic import.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "HbciPaymentSubmission": { "properties": { "total_amount": { "type": "number", "format": "float" }, "billing_payment_profile_id": { "type": "integer" }, "hbci_credential_id": { "type": "integer" }, "session_token": { "type": "string" }, "tan_challenge": { "type": "string" }, "is_decoupled": { "type": "boolean" }, "prepared_by_id": { "type": "integer" }, "prepared_by_name": { "type": "string" }, "approved_by_name": { "type": "string" }, "resolved_by_name": { "type": "string" }, "has_blocking_warnings": { "type": "boolean" }, "id": { "title": "Primary key of the payment submission.", "description": "Internal ID.", "type": "integer" }, "type": { "title": "Type of the submission, for example direct debit or transfer.", "type": "string" }, "status": { "title": "Status of the submission, for example prepared, approved or sent.", "type": "string" }, "batch_key": { "title": "Key of the batch the submission belongs to.", "type": "string" }, "execution_name": { "title": "Name of the execution.", "type": "string" }, "pain_format": { "title": "Format of the SEPA file, for example pain.008.", "type": "string" }, "pain_xml_hash": { "title": "Hash of the SEPA XML file.", "type": "string" }, "transaction_count": { "title": "Number of transactions in the submission.", "type": "integer" }, "total_cents": { "title": "Total amount of the submission in cents.", "type": "integer" }, "requested_date": { "title": "Requested execution date.", "type": "string", "format": "date-time" }, "sequence_type": { "title": "Sequence type of the direct debits, for example first or recurring.", "type": "string" }, "own_iban": { "title": "IBAN of the creditor.", "type": "string" }, "own_name": { "title": "Name of the creditor.", "type": "string" }, "creditor_id": { "title": "Creditor ID of the creditor.", "type": "string" }, "order_sent": { "title": "The order was sent to the bank.", "type": "boolean" }, "tan_submitted": { "title": "The TAN for the submission was entered.", "type": "boolean" }, "error_message": { "title": "Error message of the submission.", "type": "string" }, "approved_at": { "title": "Time the submission was approved.", "type": "string", "format": "date-time" }, "submitted_at": { "title": "Time the submission was sent to the bank.", "type": "string", "format": "date-time" }, "resolution": { "title": "Resolution of the submission.", "type": "string" }, "resolution_note": { "title": "Note on how the submission was resolved.", "type": "string" }, "resolved_at": { "title": "Time the submission was resolved.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "HbciSession": { "properties": { "id": { "title": "Primary key of the HBCI session.", "description": "Internal ID.", "type": "integer" }, "hbci_credential": { "title": "HBCI credential used for the session.", "oneOf": [ { "$ref": "#\/components\/schemas\/HbciCredential3" } ] }, "session_token": { "title": "Token of the session.", "type": "string" }, "status": { "title": "Status of the session, for example running, waiting for TAN or done.", "type": "string" }, "action_type": { "title": "Action of the session, for example fetch transactions or send payment.", "type": "string" }, "tan_challenge": { "title": "TAN challenge text shown to the user.", "type": "string" }, "tan_challenge_image": { "title": "TAN challenge image, for example for chip TAN.", "type": "string" }, "tan_challenge_image_mime": { "title": "MIME type of the TAN challenge image.", "type": "string" }, "is_decoupled": { "title": "The TAN is confirmed in the bank app.", "type": "boolean" }, "expires_at": { "title": "Time the session expires.", "type": "string", "format": "date-time" }, "error_message": { "title": "Error message of the session.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ImportedPaymentTransaction": { "properties": { "ignored": { "title": "The transaction is ignored in the matching.", "type": "boolean" }, "linked": { "title": "The transaction is linked to a document.", "type": "boolean" }, "auto_linked": { "title": "The transaction was linked automatically.", "type": "boolean" }, "is_duplicate": { "title": "The transaction is a duplicate of an earlier import.", "type": "boolean" }, "incoming": { "title": "The transaction is incoming money.", "type": "boolean" }, "currency": { "title": "Currency of the transaction, for example EUR.", "type": "string" }, "brutto_value": { "title": "Gross amount of the transaction.", "type": "number", "format": "float" }, "transaction_group": { "title": "Group the transaction belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ImportedPaymentTransactionGroup" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "ImportedPaymentTransaction2": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "ignored": { "title": "The transaction is ignored in the matching.", "type": "boolean" }, "linked": { "title": "The transaction is linked to a document.", "type": "boolean" }, "auto_linked": { "title": "The transaction was linked automatically.", "type": "boolean" }, "is_duplicate": { "title": "The transaction is a duplicate of an earlier import.", "type": "boolean" }, "incoming": { "title": "The transaction is incoming money.", "type": "boolean" }, "currency": { "title": "Currency of the transaction, for example EUR.", "type": "string" }, "brutto_value": { "title": "Gross amount of the transaction.", "type": "number", "format": "float" }, "linked_sepa_payment_transaction": { "title": "SEPA transaction the import is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/SepaPaymentTransaction2" } ] }, "linked_payment_transaction": { "title": "Payment transaction the import is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentTransaction3" } ] }, "linked_fee_payment_transaction": { "title": "Fee transaction the import is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentTransaction3" } ] }, "linked_invoice": { "title": "Invoice the import is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice20" } ] }, "linked_incoming_invoice": { "title": "Incoming invoice the import is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/IncomingInvoice4" } ] }, "linked_incoming_invoice_transaction": { "title": "Incoming invoice transaction the import is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/IncomingInvoiceTransaction2" } ] }, "linked_donation": { "title": "Donation the import is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Donation" } ] }, "transaction_group": { "title": "Group the transaction belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ImportedPaymentTransactionGroup2" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "ImportedPaymentTransactionGroup": { "properties": { "linked": { "title": "The group is linked to a document.", "type": "boolean" }, "auto_linked": { "title": "The group was linked automatically.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ImportedPaymentTransactionGroup2": { "properties": { "linked": { "title": "The group is linked to a document.", "type": "boolean" }, "auto_linked": { "title": "The group was linked automatically.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "IncomingInvoice": { "required": [ "tax" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "external_invoice_number": { "title": "Externe Rechnungsnummer des Lieferanten", "type": "string" }, "received_date": { "title": "Eingangsdatum (wann wurde die Rechnung empfangen)", "type": "string", "format": "date-time" }, "payment_date": { "title": "Zahlungsdatum", "type": "string", "format": "date-time" }, "service_date_start": { "title": "Leistungszeitraum Start", "type": "string", "format": "date-time" }, "service_date_end": { "title": "Leistungszeitraum Ende", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Auf der Eingangsseite entscheidet er dar\u00fcber, ob die Vorsteuer unter\nKennzahl 66 steht (Rechnung eines anderen Unternehmers), unter 61\n(innergemeinschaftlicher Erwerb), unter 62 (Einfuhrumsatzsteuer) oder\nunter 67 (\u00a7 13b UStG). Beim Erwerb und bei \u00a7 13b kommt eine zweite\nZeile hinzu: die Steuer schulden wir selbst, obwohl sie uns niemand\nberechnet hat, und sie steht deshalb zugleich als Umsatzsteuer im\nVordruck. Wer nur eine der beiden bucht, zahlt zu viel oder zu wenig.\n\nOhne Angabe der Regelfall.", "type": "string" }, "vat_self_assessed_rate": { "title": "Der Steuersatz, mit dem die selbst geschuldete Steuer zu rechnen ist.", "description": "Beim innergemeinschaftlichen Erwerb und bei \u00a7 13b UStG berechnet der\nLieferant keine Steuer - die Rechnung ist netto, und die Steuer schulden\nwir. Womit sie zu rechnen ist, steht deshalb auf keinem Beleg: es ist\nder Satz, der im Inland auf diese Leistung anzuwenden w\u00e4re.\n\nOhne Angabe rechnet die Voranmeldung mit dem Regelsatz und sagt in den\nHinweisen, bei wie vielen Belegen sie das getan hat. Stillschweigend zu\nraten w\u00e4re in einer Steueranmeldung das Falsche.", "type": "number", "format": "float" }, "import_vat_amount": { "title": "Die Einfuhrumsatzsteuer aus dem Zollbescheid.", "description": "Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer\nEinfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur\nder entrichtete Betrag ist als Vorsteuer abziehbar (\u00a7 15 Abs. 1 Satz 1\nNr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der\nLieferantenrechnung daf\u00fcr zu nehmen war schlicht der falsche Beleg.", "type": "string" }, "paid_value": { "title": "Bereits bezahlter Betrag (f\u00fcr Teilzahlungen)", "type": "number", "format": "float" }, "items": { "title": "Rechnungspositionen", "type": "array", "items": { "$ref": "#\/components\/schemas\/IncomingInvoiceItem" } }, "seller": { "title": "Verk\u00e4ufer\/Lieferant Informationen (Snapshot)", "oneOf": [ { "$ref": "#\/components\/schemas\/IncomingInvoiceSeller" } ] }, "expense_category": { "title": "Hauptkategorie f\u00fcr E\u00dcR", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "payment_transactions": { "title": "Verkn\u00fcpfte Zahlungstransaktionen", "type": "array", "items": { "$ref": "#\/components\/schemas\/PaymentTransaction4" } }, "incoming_invoice_transactions": { "title": "Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.", "type": "array", "items": { "$ref": "#\/components\/schemas\/IncomingInvoiceTransaction2" } }, "document_path": { "title": "Pfad zur gespeicherten Rechnungsdatei (PDF\/Bild)", "type": "string" }, "document_filename": { "title": "Original Dateiname", "type": "string" }, "document_mime_type": { "title": "MIME Type des Dokuments", "type": "string" }, "notes": { "title": "Notizen\/Bemerkungen", "type": "string" }, "is_deductible": { "title": "Ist die Rechnung f\u00fcr den Vorsteuerabzug relevant?", "type": "boolean" }, "is_approved": { "title": "Wurde die Rechnung gepr\u00fcft\/freigegeben?", "type": "boolean" }, "approved_at": { "title": "Time the incoming invoice was approved.", "type": "string", "format": "date-time" } }, "type": "object" }, "IncomingInvoice2": { "required": [ "tax" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "company": { "$ref": "#\/components\/schemas\/CRMCompany" }, "external_invoice_number": { "title": "Externe Rechnungsnummer des Lieferanten", "type": "string" }, "received_date": { "title": "Eingangsdatum (wann wurde die Rechnung empfangen)", "type": "string", "format": "date-time" }, "payment_date": { "title": "Zahlungsdatum", "type": "string", "format": "date-time" }, "service_date_start": { "title": "Leistungszeitraum Start", "type": "string", "format": "date-time" }, "service_date_end": { "title": "Leistungszeitraum Ende", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Auf der Eingangsseite entscheidet er dar\u00fcber, ob die Vorsteuer unter\nKennzahl 66 steht (Rechnung eines anderen Unternehmers), unter 61\n(innergemeinschaftlicher Erwerb), unter 62 (Einfuhrumsatzsteuer) oder\nunter 67 (\u00a7 13b UStG). Beim Erwerb und bei \u00a7 13b kommt eine zweite\nZeile hinzu: die Steuer schulden wir selbst, obwohl sie uns niemand\nberechnet hat, und sie steht deshalb zugleich als Umsatzsteuer im\nVordruck. Wer nur eine der beiden bucht, zahlt zu viel oder zu wenig.\n\nOhne Angabe der Regelfall.", "type": "string" }, "vat_self_assessed_rate": { "title": "Der Steuersatz, mit dem die selbst geschuldete Steuer zu rechnen ist.", "description": "Beim innergemeinschaftlichen Erwerb und bei \u00a7 13b UStG berechnet der\nLieferant keine Steuer - die Rechnung ist netto, und die Steuer schulden\nwir. Womit sie zu rechnen ist, steht deshalb auf keinem Beleg: es ist\nder Satz, der im Inland auf diese Leistung anzuwenden w\u00e4re.\n\nOhne Angabe rechnet die Voranmeldung mit dem Regelsatz und sagt in den\nHinweisen, bei wie vielen Belegen sie das getan hat. Stillschweigend zu\nraten w\u00e4re in einer Steueranmeldung das Falsche.", "type": "number", "format": "float" }, "import_vat_amount": { "title": "Die Einfuhrumsatzsteuer aus dem Zollbescheid.", "description": "Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer\nEinfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur\nder entrichtete Betrag ist als Vorsteuer abziehbar (\u00a7 15 Abs. 1 Satz 1\nNr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der\nLieferantenrechnung daf\u00fcr zu nehmen war schlicht der falsche Beleg.", "type": "string" }, "paid_value": { "title": "Bereits bezahlter Betrag (f\u00fcr Teilzahlungen)", "type": "number", "format": "float" }, "seller": { "title": "Verk\u00e4ufer\/Lieferant Informationen (Snapshot)", "oneOf": [ { "$ref": "#\/components\/schemas\/IncomingInvoiceSeller" } ] }, "expense_category": { "title": "Hauptkategorie f\u00fcr E\u00dcR", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "document_path": { "title": "Pfad zur gespeicherten Rechnungsdatei (PDF\/Bild)", "type": "string" }, "document_filename": { "title": "Original Dateiname", "type": "string" }, "document_mime_type": { "title": "MIME Type des Dokuments", "type": "string" }, "notes": { "title": "Notizen\/Bemerkungen", "type": "string" }, "is_deductible": { "title": "Ist die Rechnung f\u00fcr den Vorsteuerabzug relevant?", "type": "boolean" }, "is_approved": { "title": "Wurde die Rechnung gepr\u00fcft\/freigegeben?", "type": "boolean" }, "approved_at": { "title": "Time the incoming invoice was approved.", "type": "string", "format": "date-time" } }, "type": "object" }, "IncomingInvoice3": { "required": [ "tax" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "external_invoice_number": { "title": "Externe Rechnungsnummer des Lieferanten", "type": "string" }, "received_date": { "title": "Eingangsdatum (wann wurde die Rechnung empfangen)", "type": "string", "format": "date-time" }, "payment_date": { "title": "Zahlungsdatum", "type": "string", "format": "date-time" }, "service_date_start": { "title": "Leistungszeitraum Start", "type": "string", "format": "date-time" }, "service_date_end": { "title": "Leistungszeitraum Ende", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Auf der Eingangsseite entscheidet er dar\u00fcber, ob die Vorsteuer unter\nKennzahl 66 steht (Rechnung eines anderen Unternehmers), unter 61\n(innergemeinschaftlicher Erwerb), unter 62 (Einfuhrumsatzsteuer) oder\nunter 67 (\u00a7 13b UStG). Beim Erwerb und bei \u00a7 13b kommt eine zweite\nZeile hinzu: die Steuer schulden wir selbst, obwohl sie uns niemand\nberechnet hat, und sie steht deshalb zugleich als Umsatzsteuer im\nVordruck. Wer nur eine der beiden bucht, zahlt zu viel oder zu wenig.\n\nOhne Angabe der Regelfall.", "type": "string" }, "vat_self_assessed_rate": { "title": "Der Steuersatz, mit dem die selbst geschuldete Steuer zu rechnen ist.", "description": "Beim innergemeinschaftlichen Erwerb und bei \u00a7 13b UStG berechnet der\nLieferant keine Steuer - die Rechnung ist netto, und die Steuer schulden\nwir. Womit sie zu rechnen ist, steht deshalb auf keinem Beleg: es ist\nder Satz, der im Inland auf diese Leistung anzuwenden w\u00e4re.\n\nOhne Angabe rechnet die Voranmeldung mit dem Regelsatz und sagt in den\nHinweisen, bei wie vielen Belegen sie das getan hat. Stillschweigend zu\nraten w\u00e4re in einer Steueranmeldung das Falsche.", "type": "number", "format": "float" }, "import_vat_amount": { "title": "Die Einfuhrumsatzsteuer aus dem Zollbescheid.", "description": "Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer\nEinfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur\nder entrichtete Betrag ist als Vorsteuer abziehbar (\u00a7 15 Abs. 1 Satz 1\nNr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der\nLieferantenrechnung daf\u00fcr zu nehmen war schlicht der falsche Beleg.", "type": "string" }, "paid_value": { "title": "Bereits bezahlter Betrag (f\u00fcr Teilzahlungen)", "type": "number", "format": "float" }, "seller": { "title": "Verk\u00e4ufer\/Lieferant Informationen (Snapshot)", "oneOf": [ { "$ref": "#\/components\/schemas\/IncomingInvoiceSeller" } ] }, "expense_category": { "title": "Hauptkategorie f\u00fcr E\u00dcR", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "document_path": { "title": "Pfad zur gespeicherten Rechnungsdatei (PDF\/Bild)", "type": "string" }, "document_filename": { "title": "Original Dateiname", "type": "string" }, "document_mime_type": { "title": "MIME Type des Dokuments", "type": "string" }, "notes": { "title": "Notizen\/Bemerkungen", "type": "string" }, "is_deductible": { "title": "Ist die Rechnung f\u00fcr den Vorsteuerabzug relevant?", "type": "boolean" }, "is_approved": { "title": "Wurde die Rechnung gepr\u00fcft\/freigegeben?", "type": "boolean" }, "approved_at": { "title": "Time the incoming invoice was approved.", "type": "string", "format": "date-time" } }, "type": "object" }, "IncomingInvoice4": { "required": [ "tax" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "external_invoice_number": { "title": "Externe Rechnungsnummer des Lieferanten", "type": "string" }, "received_date": { "title": "Eingangsdatum (wann wurde die Rechnung empfangen)", "type": "string", "format": "date-time" }, "payment_date": { "title": "Zahlungsdatum", "type": "string", "format": "date-time" }, "service_date_start": { "title": "Leistungszeitraum Start", "type": "string", "format": "date-time" }, "service_date_end": { "title": "Leistungszeitraum Ende", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Auf der Eingangsseite entscheidet er dar\u00fcber, ob die Vorsteuer unter\nKennzahl 66 steht (Rechnung eines anderen Unternehmers), unter 61\n(innergemeinschaftlicher Erwerb), unter 62 (Einfuhrumsatzsteuer) oder\nunter 67 (\u00a7 13b UStG). Beim Erwerb und bei \u00a7 13b kommt eine zweite\nZeile hinzu: die Steuer schulden wir selbst, obwohl sie uns niemand\nberechnet hat, und sie steht deshalb zugleich als Umsatzsteuer im\nVordruck. Wer nur eine der beiden bucht, zahlt zu viel oder zu wenig.\n\nOhne Angabe der Regelfall.", "type": "string" }, "vat_self_assessed_rate": { "title": "Der Steuersatz, mit dem die selbst geschuldete Steuer zu rechnen ist.", "description": "Beim innergemeinschaftlichen Erwerb und bei \u00a7 13b UStG berechnet der\nLieferant keine Steuer - die Rechnung ist netto, und die Steuer schulden\nwir. Womit sie zu rechnen ist, steht deshalb auf keinem Beleg: es ist\nder Satz, der im Inland auf diese Leistung anzuwenden w\u00e4re.\n\nOhne Angabe rechnet die Voranmeldung mit dem Regelsatz und sagt in den\nHinweisen, bei wie vielen Belegen sie das getan hat. Stillschweigend zu\nraten w\u00e4re in einer Steueranmeldung das Falsche.", "type": "number", "format": "float" }, "import_vat_amount": { "title": "Die Einfuhrumsatzsteuer aus dem Zollbescheid.", "description": "Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer\nEinfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur\nder entrichtete Betrag ist als Vorsteuer abziehbar (\u00a7 15 Abs. 1 Satz 1\nNr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der\nLieferantenrechnung daf\u00fcr zu nehmen war schlicht der falsche Beleg.", "type": "string" }, "paid_value": { "title": "Bereits bezahlter Betrag (f\u00fcr Teilzahlungen)", "type": "number", "format": "float" }, "seller": { "title": "Verk\u00e4ufer\/Lieferant Informationen (Snapshot)", "oneOf": [ { "$ref": "#\/components\/schemas\/IncomingInvoiceSeller4" } ] }, "expense_category": { "title": "Hauptkategorie f\u00fcr E\u00dcR", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "document_path": { "title": "Pfad zur gespeicherten Rechnungsdatei (PDF\/Bild)", "type": "string" }, "document_filename": { "title": "Original Dateiname", "type": "string" }, "document_mime_type": { "title": "MIME Type des Dokuments", "type": "string" }, "notes": { "title": "Notizen\/Bemerkungen", "type": "string" }, "is_deductible": { "title": "Ist die Rechnung f\u00fcr den Vorsteuerabzug relevant?", "type": "boolean" }, "is_approved": { "title": "Wurde die Rechnung gepr\u00fcft\/freigegeben?", "type": "boolean" }, "approved_at": { "title": "Time the incoming invoice was approved.", "type": "string", "format": "date-time" } }, "type": "object" }, "IncomingInvoiceItem": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "expense_category": { "title": "Kostenkategorie f\u00fcr E\u00dcR (kann von der Hauptkategorie der Rechnung abweichen)", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "position": { "title": "Position\/Reihenfolge", "type": "integer" } }, "type": "object" }, "IncomingInvoiceSeller": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" } }, "type": "object" }, "IncomingInvoiceSeller4": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" } }, "type": "object" }, "IncomingInvoiceTransaction": { "properties": { "incoming_invoice": { "title": "Incoming invoice that was paid.", "oneOf": [ { "$ref": "#\/components\/schemas\/IncomingInvoice3" } ] }, "amount": { "title": "Positiver Betrag dieser konkreten Zahlung.", "type": "number", "format": "float" }, "payment_date": { "title": "Date of the payment.", "type": "string", "format": "date-time" }, "currency": { "title": "Currency of the payment.", "type": "string" }, "buchhaltungs_butler_transaction_id": { "title": "ID of the transaction in the external accounting tool.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "IncomingInvoiceTransaction2": { "properties": { "amount": { "title": "Positiver Betrag dieser konkreten Zahlung.", "type": "number", "format": "float" }, "payment_date": { "title": "Date of the payment.", "type": "string", "format": "date-time" }, "currency": { "title": "Currency of the payment.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "InstallationConfig": { "properties": { "id": { "title": "Primary key of the installation configuration.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "Whether the configuration is active.", "type": "boolean" }, "backup": { "title": "Backup settings of the installation.", "oneOf": [ { "$ref": "#\/components\/schemas\/BackupConfig" } ] }, "cookie": { "title": "Cookie settings of the installation.", "oneOf": [ { "$ref": "#\/components\/schemas\/CookieConfig" } ] }, "piwik": { "title": "Piwik tracking settings of the installation.", "oneOf": [ { "$ref": "#\/components\/schemas\/PiwikConfig" } ] }, "security": { "title": "Security settings of the installation.", "oneOf": [ { "$ref": "#\/components\/schemas\/SecurityConfig" } ] }, "analytics": { "title": "Analytics settings of the installation.", "oneOf": [ { "$ref": "#\/components\/schemas\/AnalyticsConfig" } ] }, "performance": { "title": "Performance settings of the installation.", "oneOf": [ { "$ref": "#\/components\/schemas\/PerformanceConfig" } ] }, "wpmail": { "title": "Mail settings of the installation.", "oneOf": [ { "$ref": "#\/components\/schemas\/WpmailConfig" } ] }, "privacy_token": { "title": "Token used for the privacy settings.", "type": "string" } }, "type": "object" }, "InventoryReport": { "properties": { "id": { "title": "Primary key of the inventory report.", "description": "Internal ID.", "type": "integer" }, "completed": { "title": "The inventory is completed.", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "InventoryReport2": { "type": "object" }, "InventoryReportItem": { "properties": { "id": { "title": "Primary key of the inventory report item.", "description": "Internal ID.", "type": "integer" }, "product": { "title": "Product that is counted.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem5" } ] }, "storage_location": { "title": "Storage location of the product.", "oneOf": [ { "$ref": "#\/components\/schemas\/StorageLocation" } ] }, "product_name": { "title": "Name of the product.", "type": "string" }, "sku": { "title": "Stock keeping unit of the product.", "type": "string" }, "barcode": { "title": "Barcode of the product.", "type": "string" }, "manufacturer": { "title": "Manufacturer of the product.", "type": "string" }, "storage_location_name": { "title": "Name of the storage location.", "type": "string" }, "is_default_location": { "title": "The storage location is the default location of the product.", "type": "boolean" }, "target_count": { "title": "Target stock count.", "type": "integer" }, "current_count": { "title": "Counted stock.", "type": "integer" }, "position": { "title": "Position of the item in the report.", "type": "integer" } }, "type": "object" }, "InventoryReportItem2": { "type": "object" }, "Invoice": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice10": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer10" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice11": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer11" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice12": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer12" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice13": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer13" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice14": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "items": { "title": "Items of the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceItem8" } }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer14" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "offer": { "title": "Offer the invoice was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer18" } ] }, "time_reports": { "title": "Time reports billed on the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ProjectTimeReport9" } }, "payment_provider_status": { "title": "Status at the payment provider.", "type": "string" }, "payment_provider_reference": { "title": "Reference at the payment provider.", "type": "string" }, "payment_provider_transaction_reference": { "title": "Transaction reference at the payment provider.", "type": "string" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "base_event_sign_up": { "title": "Sign-up the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] }, "base_booking": { "title": "Booking the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup3" } ] }, "person_log_book_entry": { "title": "Log book entry of the person the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/PersonLogBookEntry10" } ] }, "media_questionnaire_answer": { "title": "Questionnaire answer the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer11" } ] }, "media_questionnaire_answer_group": { "title": "Questionnaire answer group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup10" } ] }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "Invoice15": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "mit_last_send_email": { "title": "Point in time the last e-mail was sent.", "type": "string", "format": "date-time" }, "mit_to_email": { "title": "E-mail address the mail is intended for.", "type": "string" }, "mit_should_send_email": { "title": "Whether an e-mail should be sent.", "type": "boolean" }, "mit_last_send_postal": { "title": "Point in time the last letter was sent.", "type": "string", "format": "date-time" }, "mit_to_address_name": { "title": "Name of the postal recipient.", "type": "string" }, "mit_to_address_street_level": { "title": "Street and house number of the postal recipient.", "type": "string" }, "mit_to_address_city": { "title": "City of the postal recipient.", "type": "string" }, "mit_to_address_zip": { "title": "Postal code of the postal recipient.", "type": "string" }, "mit_to_address_country": { "title": "Country of the postal recipient.", "type": "string" }, "mit_should_send_postal": { "title": "Whether a letter should be sent.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer15" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice16": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer16" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice18": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer17" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice19": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer18" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "Invoice2": { "required": [ "accounting_type" ], "properties": { "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType6" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "items": { "title": "Items of the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceItem2" } }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer2" } ] }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile9" } }, "type": "object" }, "Invoice20": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer19" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "Invoice21": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer20" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice22": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer21" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice23": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer22" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice24": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer23" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice25": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer24" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice26": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer25" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice27": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer26" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice28": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer27" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice29": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer28" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice3": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "items": { "title": "Items of the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceItem3" } }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer3" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "offer": { "title": "Offer the invoice was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer9" } ] }, "time_reports": { "title": "Time reports billed on the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ProjectTimeReport4" } }, "payment_provider_status": { "title": "Status at the payment provider.", "type": "string" }, "payment_provider_reference": { "title": "Reference at the payment provider.", "type": "string" }, "payment_provider_transaction_reference": { "title": "Transaction reference at the payment provider.", "type": "string" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "base_event_sign_up": { "title": "Sign-up the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "base_booking": { "title": "Booking the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking12" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup2" } ] }, "person_log_book_entry": { "title": "Log book entry of the person the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/PersonLogBookEntry10" } ] }, "media_questionnaire_answer": { "title": "Questionnaire answer the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer11" } ] }, "media_questionnaire_answer_group": { "title": "Questionnaire answer group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup10" } ] }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "Invoice30": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer29" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice31": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer30" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice32": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer31" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice33": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer32" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice34": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer33" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice35": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer34" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice4": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "mit_last_send_email": { "title": "Point in time the last e-mail was sent.", "type": "string", "format": "date-time" }, "mit_to_email": { "title": "E-mail address the mail is intended for.", "type": "string" }, "mit_should_send_email": { "title": "Whether an e-mail should be sent.", "type": "boolean" }, "mit_last_send_postal": { "title": "Point in time the last letter was sent.", "type": "string", "format": "date-time" }, "mit_to_address_name": { "title": "Name of the postal recipient.", "type": "string" }, "mit_to_address_street_level": { "title": "Street and house number of the postal recipient.", "type": "string" }, "mit_to_address_city": { "title": "City of the postal recipient.", "type": "string" }, "mit_to_address_zip": { "title": "Postal code of the postal recipient.", "type": "string" }, "mit_to_address_country": { "title": "Country of the postal recipient.", "type": "string" }, "mit_should_send_postal": { "title": "Whether a letter should be sent.", "type": "boolean" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "items": { "title": "Items of the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceItem4" } }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer4" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "offer": { "title": "Offer the invoice was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer10" } ] }, "time_reports": { "title": "Time reports billed on the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ProjectTimeReport5" } }, "payment_provider_status": { "title": "Status at the payment provider.", "type": "string" }, "payment_provider_reference": { "title": "Reference at the payment provider.", "type": "string" }, "payment_provider_transaction_reference": { "title": "Transaction reference at the payment provider.", "type": "string" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "base_event_sign_up": { "title": "Sign-up the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "base_booking": { "title": "Booking the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking14" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup2" } ] }, "person_log_book_entry": { "title": "Log book entry of the person the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/PersonLogBookEntry6" } ] }, "media_questionnaire_answer": { "title": "Questionnaire answer the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer12" } ] }, "media_questionnaire_answer_group": { "title": "Questionnaire answer group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup10" } ] }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "Invoice5": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "items": { "title": "Items of the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceItem5" } }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer5" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "offer": { "title": "Offer the invoice was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer11" } ] }, "time_reports": { "title": "Time reports billed on the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ProjectTimeReport6" } }, "payment_provider_status": { "title": "Status at the payment provider.", "type": "string" }, "payment_provider_reference": { "title": "Reference at the payment provider.", "type": "string" }, "payment_provider_transaction_reference": { "title": "Transaction reference at the payment provider.", "type": "string" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "base_event_sign_up": { "title": "Sign-up the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "base_booking": { "title": "Booking the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking12" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup2" } ] }, "person_log_book_entry": { "title": "Log book entry of the person the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/PersonLogBookEntry" } ] }, "media_questionnaire_answer": { "title": "Questionnaire answer the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer11" } ] }, "media_questionnaire_answer_group": { "title": "Questionnaire answer group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup10" } ] }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice6": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "items": { "title": "Items of the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceItem6" } }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer6" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "offer": { "title": "Offer the invoice was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer12" } ] }, "time_reports": { "title": "Time reports billed on the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ProjectTimeReport7" } }, "payment_provider_status": { "title": "Status at the payment provider.", "type": "string" }, "payment_provider_reference": { "title": "Reference at the payment provider.", "type": "string" }, "payment_provider_transaction_reference": { "title": "Transaction reference at the payment provider.", "type": "string" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "base_event_sign_up": { "title": "Sign-up the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "base_booking": { "title": "Booking the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking12" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup2" } ] }, "person_log_book_entry": { "title": "Log book entry of the person the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/PersonLogBookEntry10" } ] }, "media_questionnaire_answer": { "title": "Questionnaire answer the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer11" } ] }, "media_questionnaire_answer_group": { "title": "Questionnaire answer group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup10" } ] }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "Invoice7": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "mit_last_send_email": { "title": "Point in time the last e-mail was sent.", "type": "string", "format": "date-time" }, "mit_to_email": { "title": "E-mail address the mail is intended for.", "type": "string" }, "mit_should_send_email": { "title": "Whether an e-mail should be sent.", "type": "boolean" }, "mit_last_send_postal": { "title": "Point in time the last letter was sent.", "type": "string", "format": "date-time" }, "mit_to_address_name": { "title": "Name of the postal recipient.", "type": "string" }, "mit_to_address_street_level": { "title": "Street and house number of the postal recipient.", "type": "string" }, "mit_to_address_city": { "title": "City of the postal recipient.", "type": "string" }, "mit_to_address_zip": { "title": "Postal code of the postal recipient.", "type": "string" }, "mit_to_address_country": { "title": "Country of the postal recipient.", "type": "string" }, "mit_should_send_postal": { "title": "Whether a letter should be sent.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "items": { "title": "Items of the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/InvoiceItem7" } }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer7" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "offer": { "title": "Offer the invoice was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer13" } ] }, "time_reports": { "title": "Time reports billed on the invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ProjectTimeReport8" } }, "payment_provider_status": { "title": "Status at the payment provider.", "type": "string" }, "payment_provider_reference": { "title": "Reference at the payment provider.", "type": "string" }, "payment_provider_transaction_reference": { "title": "Transaction reference at the payment provider.", "type": "string" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "base_event_sign_up": { "title": "Sign-up the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "base_booking": { "title": "Booking the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking12" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup2" } ] }, "person_log_book_entry": { "title": "Log book entry of the person the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/PersonLogBookEntry" } ] }, "media_questionnaire_answer": { "title": "Questionnaire answer the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer11" } ] }, "media_questionnaire_answer_group": { "title": "Questionnaire answer group the invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup10" } ] }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice8": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer8" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" } }, "type": "object" }, "Invoice9": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Rechnung (Einnahmen-Zuordnung)\nWenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/InvoiceBuyer9" } ] }, "payment_date": { "title": "Date the invoice was paid.", "type": "string", "format": "date-time" }, "vat_category": { "title": "Der umsatzsteuerliche Sachverhalt.", "description": "Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz\ngeh\u00f6rt. Null Prozent stehen an einer innergemeinschaftlichen Lieferung\n(Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach \u00a7 13b UStG\n(60) und an einem steuerfreien Umsatz nach \u00a7 4 UStG (48) - vier\nverschiedene Zeilen, derselbe Steuersatz.\n\nHier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der\nRechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware\ngeht. Sp\u00e4ter ist es nicht mehr rekonstruierbar.\n\nOhne Angabe der Regelfall - alles andere war bisher nicht erfassbar.", "type": "string" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "direct_debit_exported": { "title": "The invoice was exported for direct debit.", "type": "boolean" }, "cancel_date": { "title": "Date the invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "start_date": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the billed period.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "InvoiceBuyer": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice" } ] } }, "type": "object" }, "InvoiceBuyer10": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice10" } ] } }, "type": "object" }, "InvoiceBuyer11": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice11" } ] } }, "type": "object" }, "InvoiceBuyer12": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice12" } ] } }, "type": "object" }, "InvoiceBuyer13": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice13" } ] } }, "type": "object" }, "InvoiceBuyer14": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice14" } ] } }, "type": "object" }, "InvoiceBuyer15": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice15" } ] } }, "type": "object" }, "InvoiceBuyer16": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice16" } ] } }, "type": "object" }, "InvoiceBuyer17": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice18" } ] } }, "type": "object" }, "InvoiceBuyer18": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice19" } ] } }, "type": "object" }, "InvoiceBuyer19": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice20" } ] } }, "type": "object" }, "InvoiceBuyer2": { "properties": { "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "accounting_software_number": { "title": "Number of the entity in the accounting software.", "type": "string" } }, "type": "object" }, "InvoiceBuyer20": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice21" } ] } }, "type": "object" }, "InvoiceBuyer21": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice22" } ] } }, "type": "object" }, "InvoiceBuyer22": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice23" } ] } }, "type": "object" }, "InvoiceBuyer23": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice24" } ] } }, "type": "object" }, "InvoiceBuyer24": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice25" } ] } }, "type": "object" }, "InvoiceBuyer25": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice26" } ] } }, "type": "object" }, "InvoiceBuyer26": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice27" } ] } }, "type": "object" }, "InvoiceBuyer27": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice28" } ] } }, "type": "object" }, "InvoiceBuyer28": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice29" } ] } }, "type": "object" }, "InvoiceBuyer29": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice30" } ] } }, "type": "object" }, "InvoiceBuyer3": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice3" } ] } }, "type": "object" }, "InvoiceBuyer30": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice31" } ] } }, "type": "object" }, "InvoiceBuyer31": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice32" } ] } }, "type": "object" }, "InvoiceBuyer32": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice33" } ] } }, "type": "object" }, "InvoiceBuyer33": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice34" } ] } }, "type": "object" }, "InvoiceBuyer34": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice35" } ] } }, "type": "object" }, "InvoiceBuyer4": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice4" } ] } }, "type": "object" }, "InvoiceBuyer5": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice5" } ] } }, "type": "object" }, "InvoiceBuyer6": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice6" } ] } }, "type": "object" }, "InvoiceBuyer7": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice7" } ] } }, "type": "object" }, "InvoiceBuyer8": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice8" } ] } }, "type": "object" }, "InvoiceBuyer9": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice9" } ] } }, "type": "object" }, "InvoiceItem": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "invoice": { "title": "Invoice the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice8" } ] }, "project_item": { "title": "Project item the invoice item was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem7" } ] }, "base_event_sign_up": { "title": "Sign-up the item was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] }, "product": { "title": "Product of the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem8" } ] } }, "type": "object" }, "InvoiceItem2": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "booking": { "title": "Booking the invoice item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking24" } ] }, "accounting_software_number": { "title": "Number of the entity in the accounting software.", "type": "string" } }, "type": "object" }, "InvoiceItem3": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "invoice": { "title": "Invoice the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice3" } ] }, "project_item": { "title": "Project item the invoice item was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem8" } ] }, "base_event_sign_up": { "title": "Sign-up the item was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "product": { "title": "Product of the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem15" } ] } }, "type": "object" }, "InvoiceItem4": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "invoice": { "title": "Invoice the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice4" } ] }, "project_item": { "title": "Project item the invoice item was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem10" } ] }, "base_event_sign_up": { "title": "Sign-up the item was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "product": { "title": "Product of the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem17" } ] } }, "type": "object" }, "InvoiceItem5": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "invoice": { "title": "Invoice the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice5" } ] }, "project_item": { "title": "Project item the invoice item was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem11" } ] }, "base_event_sign_up": { "title": "Sign-up the item was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "product": { "title": "Product of the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem18" } ] } }, "type": "object" }, "InvoiceItem6": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "invoice": { "title": "Invoice the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice6" } ] }, "project_item": { "title": "Project item the invoice item was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem12" } ] }, "base_event_sign_up": { "title": "Sign-up the item was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "unified_category": { "title": "Category the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory36" } ] }, "product": { "title": "Product of the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem19" } ] } }, "type": "object" }, "InvoiceItem7": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "invoice": { "title": "Invoice the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice7" } ] }, "project_item": { "title": "Project item the invoice item was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem13" } ] }, "base_event_sign_up": { "title": "Sign-up the item was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "product": { "title": "Product of the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem20" } ] } }, "type": "object" }, "InvoiceItem8": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "invoice": { "title": "Invoice the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice14" } ] }, "project_item": { "title": "Project item the invoice item was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem9" } ] }, "base_event_sign_up": { "title": "Sign-up the item was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] }, "product": { "title": "Product of the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem16" } ] } }, "type": "object" }, "JournalEntry": { "properties": { "debit_total": { "title": "Summe der Sollbetr\u00e4ge.", "type": "number", "format": "float" }, "credit_total": { "title": "Summe der Habenbetr\u00e4ge.", "type": "number", "format": "float" }, "is_balanced": { "title": "Soll gleich Haben - die Grundregel der doppelten Buchf\u00fchrung.", "type": "boolean" }, "id": { "title": "Primary key of the journal entry.", "description": "Internal ID.", "type": "integer" }, "entry_number": { "title": "Fortlaufende Buchungsnummer, vergeben beim Festschreiben.", "description": "Erst dann, weil die GoBD eine l\u00fcckenlose Nummerierung der\nfestgeschriebenen Buchungen verlangt - eine verworfene Erfassung darf\nkeine L\u00fccke hinterlassen.", "type": "string" }, "entry_date": { "title": "Buchungsdatum - bestimmt, in welche Periode die Buchung f\u00e4llt.", "type": "string", "format": "date-time" }, "document_date": { "title": "Belegdatum - das Datum auf dem Papier. Kann vom Buchungsdatum abweichen.", "type": "string", "format": "date-time" }, "document_number": { "title": "Belegnummer - die Br\u00fccke zwischen Buchung und Beleg. Ohne sie ist die\nBuchung nicht nachvollziehbar (\"keine Buchung ohne Beleg\").", "type": "string" }, "fiscal_year": { "title": "Fiscal year the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/FiscalYear" } ] }, "period": { "title": "Buchungsperiode innerhalb des Gesch\u00e4ftsjahres.", "description": "1 bis 12 f\u00fcr die laufenden Monate, 13 f\u00fcr die Abschlussperiode. Die\nZahl wird aus dem Buchungsdatum abgeleitet, sobald sie nicht ausdr\u00fccklich\ngesetzt ist - nur der Abschluss setzt sie selbst.\n\nDie Spalte heisst `accounting_period` und nicht `period`: MariaDB h\u00e4lt\nPERIOD seit der System-Versionierung (`PERIOD FOR SYSTEM_TIME`) als\nSchl\u00fcsselwort frei, und die Migration scheitert daran. Das Feld in PHP\nbleibt `period` - DQL und die JSON-Ausgabe \u00e4ndern sich damit nicht.", "type": "integer" }, "status": { "title": "Status of the entry, for example draft or posted.", "type": "string" }, "source_type": { "title": "Source of the entry, for example invoice or payment.", "type": "string" }, "source_id": { "title": "Id des ausl\u00f6senden Belegs, damit sich Buchung und Beleg gegenseitig\nfinden - und damit derselbe Beleg nicht zweimal gebucht wird.", "type": "integer" }, "reversal_of": { "title": "Die Buchung, die durch diese hier storniert wird.", "oneOf": [ { "$ref": "#\/components\/schemas\/JournalEntry" } ] }, "posted_at": { "title": "Time the entry was posted.", "type": "string", "format": "date-time" }, "posted_by": { "title": "Login user who posted the entry.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "lines": { "title": "Lines of the entry.", "type": "array", "items": { "$ref": "#\/components\/schemas\/JournalEntryLine" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "JournalEntryLine": { "properties": { "id": { "title": "Primary key of the journal entry line.", "description": "Internal ID.", "type": "integer" }, "ledger_account": { "title": "Ledger account that is booked.", "oneOf": [ { "$ref": "#\/components\/schemas\/LedgerAccount" } ] }, "cost_center": { "title": "Cost center of the booking.", "oneOf": [ { "$ref": "#\/components\/schemas\/CostCenter" } ] }, "debit": { "title": "Sollbetrag. Aktiv- und Aufwandskonten mehren sich hier.", "description": "DECIMAL und nicht DOUBLE. Ein binaerer Fliesskommawert kann 0,10 Euro\nnicht darstellen; bei einer einzelnen Buchung faellt das durch das\nRunden auf Cent nicht auf, ueber eine Summenspalte mit zehntausend\nZeilen schon. Die Datenbank rechnet DECIMAL exakt, und genau ueber diese\nSpalten laufen die Summen der Saldenliste.\n\nNach aussen bleibt es float: Doctrine liefert DECIMAL als Zeichenkette,\ndie Getter wandeln um, und die Setter schreiben sie auf zwei\nNachkommastellen normiert zurueck.", "type": "number", "format": "float" }, "credit": { "title": "Habenbetrag. Passiv-, Eigenkapital- und Ertragskonten mehren sich hier.", "type": "number", "format": "float" }, "line_description": { "title": "Buchungstext der Zeile. Fehlt er, gilt der Text des Buchungssatzes.", "type": "string" }, "position": { "title": "Position of the line in the journal entry.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "KioskDevice": { "properties": { "session_active": { "title": "Whether someone is logged in right now - for the management UI, without\nsaying who.", "type": "boolean" }, "id": { "title": "Primary key of the kiosk device.", "description": "Internal ID.", "type": "integer" }, "device_id": { "title": "Public identifier of the device, sent in the x-iw-kiosk-device-id header.", "type": "string" }, "last_seen_at": { "title": "Last request of the device.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "KioskDevice2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "LedgerAccount": { "properties": { "display_name": { "type": "string" }, "id": { "title": "Primary key of the ledger account.", "description": "Internal ID.", "type": "integer" }, "number": { "title": "Kontonummer im Kontenrahmen, z.B. \"1200\" (SKR03 Bank) oder \"40000\" (SKR42).", "description": "Als String gef\u00fchrt, weil SKR42 f\u00fcnfstellig ist und f\u00fchrende Nullen\nbedeutungstragend sein k\u00f6nnen.", "type": "string" }, "chart_of_accounts": { "title": "Chart of accounts the account belongs to, for example SKR03.", "type": "string" }, "account_type": { "title": "Type of the account, for example asset or revenue.", "type": "string" }, "default_tax": { "title": "Steuersatz, der beim Buchen auf dieses Konto vorgeschlagen wird.", "description": "Bei Erl\u00f6s- und Aufwandskonten ist der Satz durch die Kontonummer\nvorgegeben (etwa \"Erl\u00f6se 19% USt\"), deshalb h\u00e4ngt er am Konto und nicht\nan der einzelnen Buchung.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "tax_account": { "title": "Gegenkonto f\u00fcr die Steuer, die beim Buchen auf dieses Konto entsteht.", "description": "Bei Erl\u00f6skonten das Umsatzsteuerkonto, bei Aufwandskonten das\nVorsteuerkonto. Damit l\u00e4sst sich aus einem Bruttobetrag automatisch der\ndreizeilige Buchungssatz erzeugen.", "oneOf": [ { "$ref": "#\/components\/schemas\/LedgerAccount" } ] }, "expense_category": { "title": "Br\u00fccke zur E\u00dcR: auf welcher Zeile der Anlage E\u00dcR dieses Konto z\u00e4hlt.", "description": "Erlaubt es, beide Gewinnermittlungsarten aus denselben Belegen zu\nbedienen - etwa im Wechseljahr oder wenn ein Verein den wirtschaftlichen\nGesch\u00e4ftsbetrieb per E\u00dcR und den Rest bilanziell f\u00fchrt.", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "cost_center_required": { "title": "Ob auf diesem Konto eine Kostenstelle angegeben werden muss.", "description": "Der SKR42 bildet die vier steuerlichen Sph\u00e4ren eines gemeinn\u00fctzigen\nVereins \u00fcber Kostenstellen ab, nicht \u00fcber getrennte Konten. F\u00fcr die\nErfolgskonten ist die Angabe dort deshalb Pflicht.", "type": "boolean" }, "is_system": { "title": "Vom Kontenrahmen-Initialisierer angelegt. Nummer und Art sind dann\ndurch den Rahmen vorgegeben und sollten nicht ge\u00e4ndert werden.", "type": "boolean" }, "is_active": { "title": "Konten lassen sich stilllegen, statt sie zu l\u00f6schen - bebuchte Konten\nd\u00fcrfen nicht verschwinden.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "LocationPlanStatusBooking": { "properties": { "id": { "type": "integer" }, "name": { "description": "null when anonymized", "type": "string", "nullable": true }, "start_time": { "type": "string", "format": "date-time" }, "end_time": { "type": "string", "format": "date-time" }, "color": { "type": "string", "nullable": true }, "fg_color": { "type": "string", "nullable": true }, "booking_type": { "type": "string", "nullable": true }, "booking_status": { "type": "string", "nullable": true }, "waiting": { "type": "boolean" }, "confirmed": { "type": "boolean" }, "participant_name": { "type": "string", "nullable": true }, "people_count": { "description": "number of people, from the booking group", "type": "integer", "nullable": true }, "people_limit": { "description": "capacity of the booking or its event", "type": "integer", "nullable": true }, "base_event": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object", "nullable": true }, "base_booking_group": { "properties": { "id": { "type": "integer" }, "name": { "type": "string", "nullable": true }, "booking_count": { "type": "integer", "nullable": true }, "start_time": { "type": "string", "format": "date-time", "nullable": true }, "end_time": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object", "nullable": true }, "performing_person": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object", "nullable": true } }, "type": "object" }, "MassUserNotification": { "properties": { "send_push": { "title": "Whether push notifications should be sent.", "type": "boolean" }, "send_mail": { "title": "Whether e-mails should be sent.", "type": "boolean" }, "send_letter": { "title": "Whether letters should be sent.", "type": "boolean" }, "send_sms": { "title": "Whether SMS messages should be sent.", "type": "boolean" }, "send_whatsapp": { "title": "Whether WhatsApp messages should be sent.", "type": "boolean" }, "reference_class_name": { "title": "Class name of the records the notification refers to.", "type": "string" }, "reference_ids": { "title": "IDs of the records the notification refers to.", "type": "array", "items": { "type": "string" } }, "text": { "title": "The headline of the notification", "type": "string", "nullable": true }, "long_text": { "title": "The text of the notification", "type": "string", "nullable": true }, "html_text": { "title": "The html text of the notification, overrides the long text", "type": "string" }, "attachments": { "title": "Attachments of the mass notification.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment12" } }, "template": { "title": "Template used for the mass notification.", "oneOf": [ { "$ref": "#\/components\/schemas\/FlexibleLatexTemplate3" } ] }, "save_as_attachment": { "title": "Whether the notification is saved as an attachment.", "type": "boolean" }, "check_for_duplicates": { "title": "Whether duplicate recipients are checked.", "type": "boolean" }, "create_questionnaire_draft": { "title": "If true, a MediaQuestionnaireAnswer draft is created (or reused) for each referenced\nBaseEventSignUp recipient, and its fill link is exposed as a template placeholder.", "type": "boolean" }, "questionnaire_draft_questionnaire": { "title": "The result-list questionnaire the per-recipient drafts are created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaire3" } ] } }, "type": "object" }, "MassUserNotification2": { "properties": { "id": { "title": "Primary key of the mass notification.", "description": "Internal ID.", "type": "integer" }, "processed": { "title": "Whether the mass notification has been processed.", "type": "boolean" }, "send_push": { "title": "Whether push notifications should be sent.", "type": "boolean" }, "send_mail": { "title": "Whether e-mails should be sent.", "type": "boolean" }, "send_letter": { "title": "Whether letters should be sent.", "type": "boolean" }, "send_sms": { "title": "Whether SMS messages should be sent.", "type": "boolean" }, "send_whatsapp": { "title": "Whether WhatsApp messages should be sent.", "type": "boolean" }, "reference_class_name": { "title": "Class name of the records the notification refers to.", "type": "string" }, "reference_ids": { "title": "IDs of the records the notification refers to.", "type": "array", "items": { "type": "string" } }, "text": { "title": "The headline of the notification", "type": "string", "nullable": true }, "long_text": { "title": "The text of the notification", "type": "string", "nullable": true }, "html_text": { "title": "The html text of the notification, overrides the long text", "type": "string" }, "attachments": { "title": "Attachments of the mass notification.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment22" } }, "template": { "title": "Template used for the mass notification.", "oneOf": [ { "$ref": "#\/components\/schemas\/FlexibleLatexTemplate" } ] }, "save_as_attachment": { "title": "Whether the notification is saved as an attachment.", "type": "boolean" }, "check_for_duplicates": { "title": "Whether duplicate recipients are checked.", "type": "boolean" }, "create_questionnaire_draft": { "title": "If true, a MediaQuestionnaireAnswer draft is created (or reused) for each referenced\nBaseEventSignUp recipient, and its fill link is exposed as a template placeholder.", "type": "boolean" }, "questionnaire_draft_questionnaire": { "title": "The result-list questionnaire the per-recipient drafts are created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaire" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "McpAccessFilter": { "properties": { "api_access_token": { "type": "integer" }, "id": { "title": "Primary key of the access filter.", "description": "Internal ID.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "McpApprovalRequest": { "properties": { "id": { "title": "Primary key of the approval request.", "description": "Internal ID.", "type": "integer" }, "status": { "title": "Status of the request: pending, approved, executed, failed, rejected, cancelled or expired.", "type": "string" }, "action_type": { "title": "Action type from the static MCP approval action map.", "type": "string" }, "title": { "title": "Short summary written by the server, not by the agent.", "type": "string" }, "reason": { "title": "Justification given by the agent.", "description": "Untrusted text. Show it as plain text only.", "type": "string" }, "target_class": { "title": "Short class name of the main record, e.g. crm_person.", "type": "string" }, "target_id": { "title": "ID of the main record.", "type": "integer" }, "requested_by_user_id": { "title": "ID of the user who requested the action.", "type": "integer" }, "requested_by": { "title": "Name of the user who requested the action.", "type": "string" }, "requested_auth_type": { "title": "How the requester logged in.", "type": "string" }, "requested_client": { "title": "Client that made the request.", "type": "string" }, "expires_at": { "title": "Point in time after which the request expires.", "type": "string", "format": "date-time" }, "decided_by_user_id": { "title": "ID of the user who approved or rejected the request.", "type": "integer" }, "decided_by": { "title": "Name of the user who approved or rejected the request.", "type": "string" }, "decided_at": { "title": "Point in time of the decision.", "type": "string", "format": "date-time" }, "decision_comment": { "title": "Comment given with the decision.", "type": "string" }, "executed_at": { "title": "Point in time the action was executed.", "type": "string", "format": "date-time" }, "error_message": { "title": "Error message if the execution failed.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "McpToolCallLog": { "properties": { "id": { "title": "Primary key of the log entry.", "description": "Internal ID.", "type": "integer" }, "created": { "title": "Point in time of the tool call.", "type": "string", "format": "date-time" }, "tool_name": { "title": "Name of the called MCP tool.", "type": "string" }, "outcome": { "title": "Outcome of the call: ok, error or denied.", "type": "string" }, "writing": { "title": "Whether the tool can change data, i.e. it is not read-only. Null for unknown tools.", "type": "boolean" }, "user_id": { "title": "ID of the calling user.", "type": "integer" }, "user_string": { "title": "Display name of the calling user.", "type": "string" }, "auth_type": { "title": "How the caller logged in: anonymous, public, session, api_token, oauth or sso_durable.", "type": "string" }, "api_access_token_id": { "title": "ID of the API access token used for the call.", "type": "integer" }, "oauth_client": { "title": "Identifier of the OAuth client used for the call.", "type": "string" }, "client_name": { "title": "Name of the client used for the call.", "type": "string" }, "client_ip": { "title": "IP address of the caller.", "type": "string" }, "error_message": { "title": "Error message if the call failed.", "type": "string" }, "duration_ms": { "title": "Duration of the call in milliseconds.", "type": "integer" }, "approval_request_id": { "title": "ID of the approval request created by the call, if any.", "type": "integer" } }, "type": "object" }, "MediaArticleSpace": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "MediaArticleSpace10": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace10" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace10" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "MediaArticleSpace11": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace11" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace11" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "MediaArticleSpace12": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace12" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace12" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage7" } } }, "type": "object" }, "MediaArticleSpace13": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace13" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace13" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "MediaArticleSpace14": { "properties": { "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace14" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "MediaArticleSpace15": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace15" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace15" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "MediaArticleSpace16": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace16" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace16" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage11" } } }, "type": "object" }, "MediaArticleSpace2": { "properties": { "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace2" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "MediaArticleSpace3": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace3" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace3" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage8" } } }, "type": "object" }, "MediaArticleSpace5": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace5" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace5" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "MediaArticleSpace6": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace6" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace6" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "MediaArticleSpace7": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace7" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace7" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage4" } } }, "type": "object" }, "MediaArticleSpace8": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace8" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace8" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage5" } } }, "type": "object" }, "MediaArticleSpace9": { "properties": { "id": { "title": "Primary key of the article space.", "description": "Internal ID.", "type": "integer" }, "children": { "title": "Child article spaces.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaArticleSpace9" } }, "parent": { "title": "Parent article space.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace9" } ] }, "public_keywords": { "title": "Keywords of the article space.", "type": "string" }, "view_order": { "title": "Sort order of the article space in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage6" } } }, "type": "object" }, "MediaCardButton": { "properties": { "id": { "title": "Primary key of the card button.", "description": "Internal ID.", "type": "integer" }, "card_type": { "title": "Type of the card, for example a home screen tile.", "type": "string" }, "card_conditions": { "title": "Conditions under which the card is shown, as text.", "type": "string" }, "token": { "title": "Public token of the card.", "description": "Used instead of the ID.", "type": "string" }, "language_code": { "title": "Language of the card, for example de or en.", "type": "string" }, "icon_asset_name": { "title": "Name of the icon of the card.", "type": "string" }, "icon_package": { "title": "Icon package the icon belongs to.", "type": "string" }, "icon_color": { "title": "Color of the icon.", "type": "string" }, "text_color": { "title": "Color of the text.", "type": "string" }, "background_color": { "title": "Background color of the card.", "type": "string" }, "link_action": { "title": "Action when the card is tapped, for example open a page.", "type": "string" }, "link_url": { "title": "URL the card links to.", "type": "string" }, "image_opacity": { "title": "Opacity of the background image, from 0 to 1.", "type": "number", "format": "float" }, "ui_preset": { "title": "Layout preset of the card.", "type": "string" }, "start_date": { "title": "Start of the display period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the display period.", "type": "string", "format": "date-time" }, "dismissable": { "title": "The user can hide the card.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "MediaCardButton2": { "properties": { "id": { "title": "Primary key of the card button.", "description": "Internal ID.", "type": "integer" }, "card_type": { "title": "Type of the card, for example a home screen tile.", "type": "string" }, "card_conditions": { "title": "Conditions under which the card is shown, as text.", "type": "string" }, "token": { "title": "Public token of the card.", "description": "Used instead of the ID.", "type": "string" }, "language_code": { "title": "Language of the card, for example de or en.", "type": "string" }, "icon_asset_name": { "title": "Name of the icon of the card.", "type": "string" }, "icon_package": { "title": "Icon package the icon belongs to.", "type": "string" }, "icon_color": { "title": "Color of the icon.", "type": "string" }, "text_color": { "title": "Color of the text.", "type": "string" }, "background_color": { "title": "Background color of the card.", "type": "string" }, "link_action": { "title": "Action when the card is tapped, for example open a page.", "type": "string" }, "link_url": { "title": "URL the card links to.", "type": "string" }, "image_opacity": { "title": "Opacity of the background image, from 0 to 1.", "type": "number", "format": "float" }, "ui_preset": { "title": "Layout preset of the card.", "type": "string" }, "start_date": { "title": "Start of the display period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End of the display period.", "type": "string", "format": "date-time" }, "dismissable": { "title": "The user can hide the card.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage10" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory28" } }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "MediaFeedbackBoard": { "properties": { "is_public": { "title": "True when the board itself may be served to callers without a session.", "type": "boolean" }, "id": { "title": "Primary key of the feedback board.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Internal name, shown in the admin UI only.", "type": "string" }, "public_title": { "title": "Title of the board shown to the public.", "type": "string" }, "public_description": { "title": "Description of the board shown to the public.", "type": "string" }, "public_key": { "title": "Stable key for the public URL and widget embedding. Server-assigned, never accepted\nfrom API input \u2014 omitted from the oaInput groups on purpose. Changing it would break\nevery page that already embeds this board.", "type": "string" }, "image_url": { "title": "URL of the image of the board.", "type": "string" }, "sort_order": { "title": "Sort order of the board in lists.", "type": "integer" }, "allow_new_entries": { "title": "Members can create new entries.", "type": "boolean" }, "allow_voting": { "title": "Members can vote on entries.", "type": "boolean" }, "allow_comments": { "title": "Members can comment on entries.", "type": "boolean" }, "allow_guest_entries": { "title": "Guests can create new entries.", "type": "boolean" }, "allow_guest_votes": { "title": "Guests can vote on entries.", "type": "boolean" }, "allow_guest_comments": { "title": "Guests can comment on entries.", "type": "boolean" }, "moderation_required": { "title": "Board-level override of the global moderation setting. Null means \"use the global\nsetting\" \u2014 that is why this is nullable and not a plain bool.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory30" } }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage12" } } }, "type": "object" }, "MediaFeedbackBoard2": { "properties": { "name": { "title": "Internal name, shown in the admin UI only.", "type": "string" }, "public_title": { "title": "Title of the board shown to the public.", "type": "string" }, "public_description": { "title": "Description of the board shown to the public.", "type": "string" }, "image_url": { "title": "URL of the image of the board.", "type": "string" }, "sort_order": { "title": "Sort order of the board in lists.", "type": "integer" }, "allow_new_entries": { "title": "Members can create new entries.", "type": "boolean" }, "allow_voting": { "title": "Members can vote on entries.", "type": "boolean" }, "allow_comments": { "title": "Members can comment on entries.", "type": "boolean" }, "allow_guest_entries": { "title": "Guests can create new entries.", "type": "boolean" }, "allow_guest_votes": { "title": "Guests can vote on entries.", "type": "boolean" }, "allow_guest_comments": { "title": "Guests can comment on entries.", "type": "boolean" }, "moderation_required": { "title": "Board-level override of the global moderation setting. Null means \"use the global\nsetting\" \u2014 that is why this is nullable and not a plain bool.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } } }, "type": "object" }, "MediaFeedbackBoard3": { "properties": { "is_public": { "title": "True when the board itself may be served to callers without a session.", "type": "boolean" }, "id": { "title": "Primary key of the feedback board.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Internal name, shown in the admin UI only.", "type": "string" }, "public_title": { "title": "Title of the board shown to the public.", "type": "string" }, "public_description": { "title": "Description of the board shown to the public.", "type": "string" }, "public_key": { "title": "Stable key for the public URL and widget embedding. Server-assigned, never accepted\nfrom API input \u2014 omitted from the oaInput groups on purpose. Changing it would break\nevery page that already embeds this board.", "type": "string" }, "image_url": { "title": "URL of the image of the board.", "type": "string" }, "sort_order": { "title": "Sort order of the board in lists.", "type": "integer" }, "allow_new_entries": { "title": "Members can create new entries.", "type": "boolean" }, "allow_voting": { "title": "Members can vote on entries.", "type": "boolean" }, "allow_comments": { "title": "Members can comment on entries.", "type": "boolean" }, "allow_guest_entries": { "title": "Guests can create new entries.", "type": "boolean" }, "allow_guest_votes": { "title": "Guests can vote on entries.", "type": "boolean" }, "allow_guest_comments": { "title": "Guests can comment on entries.", "type": "boolean" }, "moderation_required": { "title": "Board-level override of the global moderation setting. Null means \"use the global\nsetting\" \u2014 that is why this is nullable and not a plain bool.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory32" } }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage13" } } }, "type": "object" }, "MediaFeedbackBoard5": { "properties": { "is_public": { "title": "True when the board itself may be served to callers without a session.", "type": "boolean" }, "id": { "title": "Primary key of the feedback board.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Internal name, shown in the admin UI only.", "type": "string" }, "public_title": { "title": "Title of the board shown to the public.", "type": "string" }, "public_description": { "title": "Description of the board shown to the public.", "type": "string" }, "public_key": { "title": "Stable key for the public URL and widget embedding. Server-assigned, never accepted\nfrom API input \u2014 omitted from the oaInput groups on purpose. Changing it would break\nevery page that already embeds this board.", "type": "string" }, "image_url": { "title": "URL of the image of the board.", "type": "string" }, "sort_order": { "title": "Sort order of the board in lists.", "type": "integer" }, "allow_new_entries": { "title": "Members can create new entries.", "type": "boolean" }, "allow_voting": { "title": "Members can vote on entries.", "type": "boolean" }, "allow_comments": { "title": "Members can comment on entries.", "type": "boolean" }, "allow_guest_entries": { "title": "Guests can create new entries.", "type": "boolean" }, "allow_guest_votes": { "title": "Guests can vote on entries.", "type": "boolean" }, "allow_guest_comments": { "title": "Guests can comment on entries.", "type": "boolean" }, "moderation_required": { "title": "Board-level override of the global moderation setting. Null means \"use the global\nsetting\" \u2014 that is why this is nullable and not a plain bool.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaFeedbackBoard6": { "properties": { "is_public": { "title": "True when the board itself may be served to callers without a session.", "type": "boolean" }, "id": { "title": "Primary key of the feedback board.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Internal name, shown in the admin UI only.", "type": "string" }, "public_title": { "title": "Title of the board shown to the public.", "type": "string" }, "public_description": { "title": "Description of the board shown to the public.", "type": "string" }, "public_key": { "title": "Stable key for the public URL and widget embedding. Server-assigned, never accepted\nfrom API input \u2014 omitted from the oaInput groups on purpose. Changing it would break\nevery page that already embeds this board.", "type": "string" }, "image_url": { "title": "URL of the image of the board.", "type": "string" }, "sort_order": { "title": "Sort order of the board in lists.", "type": "integer" }, "allow_new_entries": { "title": "Members can create new entries.", "type": "boolean" }, "allow_voting": { "title": "Members can vote on entries.", "type": "boolean" }, "allow_comments": { "title": "Members can comment on entries.", "type": "boolean" }, "allow_guest_entries": { "title": "Guests can create new entries.", "type": "boolean" }, "allow_guest_votes": { "title": "Guests can vote on entries.", "type": "boolean" }, "allow_guest_comments": { "title": "Guests can comment on entries.", "type": "boolean" }, "moderation_required": { "title": "Board-level override of the global moderation setting. Null means \"use the global\nsetting\" \u2014 that is why this is nullable and not a plain bool.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory34" } }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage14" } } }, "type": "object" }, "MediaFeedbackComment": { "properties": { "author_name": { "type": "string" }, "id": { "title": "Primary key of the feedback comment.", "description": "Internal ID.", "type": "integer" }, "entry": { "title": "Feedback entry the comment belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry8" } ] }, "text": { "title": "Text of the comment.", "type": "string" }, "social_profile": { "title": "Profile that wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "guest_name": { "title": "Name of the guest who wrote the comment.", "type": "string" }, "guest_email": { "title": "Scope-only.", "type": "string" }, "is_official": { "title": "Marks a reply written on behalf of the operator, so the UI can set it apart from\ncommunity comments.", "type": "boolean" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderation_reason": { "title": "Reason for the moderation decision.", "type": "string" }, "moderated_at": { "title": "Time the comment was moderated.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaFeedbackComment2": { "properties": { "entry": { "title": "Feedback entry the comment belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry9" } ] }, "text": { "title": "Text of the comment.", "type": "string" }, "social_profile": { "title": "Profile that wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile16" } ] }, "guest_name": { "title": "Name of the guest who wrote the comment.", "type": "string" }, "is_official": { "title": "Marks a reply written on behalf of the operator, so the UI can set it apart from\ncommunity comments.", "type": "boolean" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderation_reason": { "title": "Reason for the moderation decision.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaFeedbackComment3": { "properties": { "author_name": { "type": "string" }, "id": { "title": "Primary key of the feedback comment.", "description": "Internal ID.", "type": "integer" }, "text": { "title": "Text of the comment.", "type": "string" }, "social_profile": { "title": "Profile that wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile23" } ] }, "guest_name": { "title": "Name of the guest who wrote the comment.", "type": "string" }, "is_official": { "title": "Marks a reply written on behalf of the operator, so the UI can set it apart from\ncommunity comments.", "type": "boolean" } }, "type": "object" }, "MediaFeedbackEntry": { "properties": { "author_name": { "title": "Display name of the author, honouring the pseudonymity the person chose on their\nsocial profile. Falls back to the guest name, then to a neutral label \u2014 never to\nan email address.", "type": "string" }, "id": { "title": "Primary key of the feedback entry.", "description": "Internal ID.", "type": "integer" }, "board": { "title": "Feedback board the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackBoard3" } ] }, "headline": { "title": "Headline of the feedback entry.", "type": "string" }, "text": { "title": "Text of the feedback entry.", "type": "string" }, "feedback_type": { "title": "Type of the feedback, for example idea or problem.", "type": "string" }, "status": { "title": "Status of the feedback, for example open, planned or done.", "type": "string" }, "status_note": { "title": "Publicly visible reason for the current status. A declined wish without a reason is\nworse than no board at all, so this is exposed to every access tier.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderation_reason": { "title": "Reason for the moderation decision.", "type": "string" }, "moderated_at": { "title": "Time the entry was moderated.", "type": "string", "format": "date-time" }, "social_profile": { "title": "Author when submitted by a logged-in person. Reuses the social profile so the\npseudonymity settings a person already chose apply here too.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "guest_name": { "title": "Name of the guest who wrote the entry.", "type": "string" }, "guest_email": { "title": "Scope-only: never exposed to public or logged-in callers.", "type": "string" }, "guest_email_confirmed": { "title": "The e-mail address of the guest was confirmed.", "type": "boolean" }, "consent_confirmed": { "title": "GDPR: guest confirmed the consent text before submitting. Same field as\nEventMoment::$consentConfirmed.", "type": "boolean" }, "attachments": { "title": "Files attached to the entry.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "vote_count": { "title": "Denormalized so lists can sort by popularity without a join. Maintained by\nMediaFeedbackVoteHelper; MediaFeedbackRecountCommand repairs it.", "type": "integer" }, "comment_count": { "title": "Number of comments on the entry.", "type": "integer" }, "duplicate_of": { "title": "Merge target. Set together with STATUS_DUPLICATE.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry" } ] }, "roadmap_items": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem3" } }, "internal_note": { "title": "Scope-only.", "type": "string" }, "internal_priority": { "title": "Scope-only.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory32" } }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage13" } } }, "type": "object" }, "MediaFeedbackEntry2": { "properties": { "board": { "title": "Feedback board the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackBoard2" } ] }, "headline": { "title": "Headline of the feedback entry.", "type": "string" }, "text": { "title": "Text of the feedback entry.", "type": "string" }, "feedback_type": { "title": "Type of the feedback, for example idea or problem.", "type": "string" }, "status": { "title": "Status of the feedback, for example open, planned or done.", "type": "string" }, "status_note": { "title": "Publicly visible reason for the current status. A declined wish without a reason is\nworse than no board at all, so this is exposed to every access tier.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderation_reason": { "title": "Reason for the moderation decision.", "type": "string" }, "social_profile": { "title": "Author when submitted by a logged-in person. Reuses the social profile so the\npseudonymity settings a person already chose apply here too.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile16" } ] }, "guest_name": { "title": "Name of the guest who wrote the entry.", "type": "string" }, "attachments": { "title": "Files attached to the entry.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment12" } }, "duplicate_of": { "title": "Merge target. Set together with STATUS_DUPLICATE.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry2" } ] }, "roadmap_items": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackRoadmapItem2" } }, "internal_note": { "title": "Scope-only.", "type": "string" }, "internal_priority": { "title": "Scope-only.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } } }, "type": "object" }, "MediaFeedbackEntry3": { "properties": { "author_name": { "title": "Display name of the author, honouring the pseudonymity the person chose on their\nsocial profile. Falls back to the guest name, then to a neutral label \u2014 never to\nan email address.", "type": "string" }, "id": { "title": "Primary key of the feedback entry.", "description": "Internal ID.", "type": "integer" }, "board": { "title": "Feedback board the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackBoard5" } ] }, "headline": { "title": "Headline of the feedback entry.", "type": "string" }, "text": { "title": "Text of the feedback entry.", "type": "string" }, "feedback_type": { "title": "Type of the feedback, for example idea or problem.", "type": "string" }, "status": { "title": "Status of the feedback, for example open, planned or done.", "type": "string" }, "status_note": { "title": "Publicly visible reason for the current status. A declined wish without a reason is\nworse than no board at all, so this is exposed to every access tier.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "social_profile": { "title": "Author when submitted by a logged-in person. Reuses the social profile so the\npseudonymity settings a person already chose apply here too.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "guest_name": { "title": "Name of the guest who wrote the entry.", "type": "string" }, "attachments": { "title": "Files attached to the entry.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "vote_count": { "title": "Denormalized so lists can sort by popularity without a join. Maintained by\nMediaFeedbackVoteHelper; MediaFeedbackRecountCommand repairs it.", "type": "integer" }, "comment_count": { "title": "Number of comments on the entry.", "type": "integer" }, "duplicate_of": { "title": "Merge target. Set together with STATUS_DUPLICATE.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry3" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaFeedbackEntry4": { "properties": { "author_name": { "title": "Display name of the author, honouring the pseudonymity the person chose on their\nsocial profile. Falls back to the guest name, then to a neutral label \u2014 never to\nan email address.", "type": "string" }, "id": { "title": "Primary key of the feedback entry.", "description": "Internal ID.", "type": "integer" }, "headline": { "title": "Headline of the feedback entry.", "type": "string" }, "text": { "title": "Text of the feedback entry.", "type": "string" }, "feedback_type": { "title": "Type of the feedback, for example idea or problem.", "type": "string" }, "status": { "title": "Status of the feedback, for example open, planned or done.", "type": "string" }, "status_note": { "title": "Publicly visible reason for the current status. A declined wish without a reason is\nworse than no board at all, so this is exposed to every access tier.", "type": "string" }, "social_profile": { "title": "Author when submitted by a logged-in person. Reuses the social profile so the\npseudonymity settings a person already chose apply here too.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile18" } ] }, "guest_name": { "title": "Name of the guest who wrote the entry.", "type": "string" }, "attachments": { "title": "Files attached to the entry.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment12" } }, "vote_count": { "title": "Denormalized so lists can sort by popularity without a join. Maintained by\nMediaFeedbackVoteHelper; MediaFeedbackRecountCommand repairs it.", "type": "integer" }, "comment_count": { "title": "Number of comments on the entry.", "type": "integer" }, "duplicate_of": { "title": "Merge target. Set together with STATUS_DUPLICATE.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry4" } ] } }, "type": "object" }, "MediaFeedbackEntry5": { "properties": { "author_name": { "title": "Display name of the author, honouring the pseudonymity the person chose on their\nsocial profile. Falls back to the guest name, then to a neutral label \u2014 never to\nan email address.", "type": "string" }, "id": { "title": "Primary key of the feedback entry.", "description": "Internal ID.", "type": "integer" }, "board": { "title": "Feedback board the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackBoard6" } ] }, "headline": { "title": "Headline of the feedback entry.", "type": "string" }, "text": { "title": "Text of the feedback entry.", "type": "string" }, "feedback_type": { "title": "Type of the feedback, for example idea or problem.", "type": "string" }, "status": { "title": "Status of the feedback, for example open, planned or done.", "type": "string" }, "status_note": { "title": "Publicly visible reason for the current status. A declined wish without a reason is\nworse than no board at all, so this is exposed to every access tier.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "social_profile": { "title": "Author when submitted by a logged-in person. Reuses the social profile so the\npseudonymity settings a person already chose apply here too.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "guest_name": { "title": "Name of the guest who wrote the entry.", "type": "string" }, "vote_count": { "title": "Denormalized so lists can sort by popularity without a join. Maintained by\nMediaFeedbackVoteHelper; MediaFeedbackRecountCommand repairs it.", "type": "integer" }, "comment_count": { "title": "Number of comments on the entry.", "type": "integer" }, "duplicate_of": { "title": "Merge target. Set together with STATUS_DUPLICATE.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry5" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory34" } }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage14" } } }, "type": "object" }, "MediaFeedbackEntry6": { "properties": { "author_name": { "title": "Display name of the author, honouring the pseudonymity the person chose on their\nsocial profile. Falls back to the guest name, then to a neutral label \u2014 never to\nan email address.", "type": "string" }, "id": { "title": "Primary key of the feedback entry.", "description": "Internal ID.", "type": "integer" }, "board": { "title": "Feedback board the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackBoard5" } ] }, "headline": { "title": "Headline of the feedback entry.", "type": "string" }, "text": { "title": "Text of the feedback entry.", "type": "string" }, "feedback_type": { "title": "Type of the feedback, for example idea or problem.", "type": "string" }, "status": { "title": "Status of the feedback, for example open, planned or done.", "type": "string" }, "status_note": { "title": "Publicly visible reason for the current status. A declined wish without a reason is\nworse than no board at all, so this is exposed to every access tier.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "social_profile": { "title": "Author when submitted by a logged-in person. Reuses the social profile so the\npseudonymity settings a person already chose apply here too.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "guest_name": { "title": "Name of the guest who wrote the entry.", "type": "string" }, "vote_count": { "title": "Denormalized so lists can sort by popularity without a join. Maintained by\nMediaFeedbackVoteHelper; MediaFeedbackRecountCommand repairs it.", "type": "integer" }, "comment_count": { "title": "Number of comments on the entry.", "type": "integer" }, "duplicate_of": { "title": "Merge target. Set together with STATUS_DUPLICATE.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry6" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaFeedbackEntry7": { "properties": { "author_name": { "title": "Display name of the author, honouring the pseudonymity the person chose on their\nsocial profile. Falls back to the guest name, then to a neutral label \u2014 never to\nan email address.", "type": "string" }, "id": { "title": "Primary key of the feedback entry.", "description": "Internal ID.", "type": "integer" }, "board": { "title": "Feedback board the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackBoard5" } ] }, "headline": { "title": "Headline of the feedback entry.", "type": "string" }, "text": { "title": "Text of the feedback entry.", "type": "string" }, "feedback_type": { "title": "Type of the feedback, for example idea or problem.", "type": "string" }, "status": { "title": "Status of the feedback, for example open, planned or done.", "type": "string" }, "status_note": { "title": "Publicly visible reason for the current status. A declined wish without a reason is\nworse than no board at all, so this is exposed to every access tier.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "social_profile": { "title": "Author when submitted by a logged-in person. Reuses the social profile so the\npseudonymity settings a person already chose apply here too.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "guest_name": { "title": "Name of the guest who wrote the entry.", "type": "string" }, "vote_count": { "title": "Denormalized so lists can sort by popularity without a join. Maintained by\nMediaFeedbackVoteHelper; MediaFeedbackRecountCommand repairs it.", "type": "integer" }, "comment_count": { "title": "Number of comments on the entry.", "type": "integer" }, "duplicate_of": { "title": "Merge target. Set together with STATUS_DUPLICATE.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry7" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaFeedbackEntry8": { "properties": { "author_name": { "title": "Display name of the author, honouring the pseudonymity the person chose on their\nsocial profile. Falls back to the guest name, then to a neutral label \u2014 never to\nan email address.", "type": "string" }, "id": { "title": "Primary key of the feedback entry.", "description": "Internal ID.", "type": "integer" }, "board": { "title": "Feedback board the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackBoard5" } ] }, "headline": { "title": "Headline of the feedback entry.", "type": "string" }, "text": { "title": "Text of the feedback entry.", "type": "string" }, "feedback_type": { "title": "Type of the feedback, for example idea or problem.", "type": "string" }, "status": { "title": "Status of the feedback, for example open, planned or done.", "type": "string" }, "status_note": { "title": "Publicly visible reason for the current status. A declined wish without a reason is\nworse than no board at all, so this is exposed to every access tier.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "social_profile": { "title": "Author when submitted by a logged-in person. Reuses the social profile so the\npseudonymity settings a person already chose apply here too.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "guest_name": { "title": "Name of the guest who wrote the entry.", "type": "string" }, "vote_count": { "title": "Denormalized so lists can sort by popularity without a join. Maintained by\nMediaFeedbackVoteHelper; MediaFeedbackRecountCommand repairs it.", "type": "integer" }, "comment_count": { "title": "Number of comments on the entry.", "type": "integer" }, "duplicate_of": { "title": "Merge target. Set together with STATUS_DUPLICATE.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry8" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaFeedbackEntry9": { "properties": { "headline": { "title": "Headline of the feedback entry.", "type": "string" }, "text": { "title": "Text of the feedback entry.", "type": "string" }, "feedback_type": { "title": "Type of the feedback, for example idea or problem.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } } }, "type": "object" }, "MediaFeedbackRoadmapItem": { "properties": { "timeline_order": { "title": "Position of this item's status group on the timeline. Unknown statuses sort last\ninstead of silently landing in the first group.", "type": "integer" }, "display_target": { "title": "What the timeline should print as the date of this milestone: the free-text label if\none was set, otherwise the target date.", "type": "string" }, "linked_entry_count": { "title": "Number of linked, still-visible feedback entries.", "type": "integer" }, "linked_vote_count": { "title": "Summed votes of all linked entries \u2014 the demand behind this milestone.", "type": "integer" }, "id": { "title": "Primary key of the roadmap item.", "description": "Internal ID.", "type": "integer" }, "title": { "title": "Title of the roadmap item.", "type": "string" }, "description": { "title": "Description of the roadmap item.", "type": "string" }, "status": { "title": "Status of the item, for example planned, in progress or released.", "type": "string" }, "start_date": { "title": "Planned start date.", "type": "string", "format": "date-time" }, "target_date": { "title": "Planned release date.", "type": "string", "format": "date-time" }, "target_label": { "title": "Free-text period (\"Q3 2026\") for when a concrete date should not be promised. Shown\ninstead of targetDate when set.", "type": "string" }, "released_at": { "title": "Time the item was released.", "type": "string", "format": "date-time" }, "release_version": { "title": "Version the item was released in.", "type": "string" }, "image_url": { "title": "URL of the image of the item.", "type": "string" }, "sort_order": { "title": "Sort order of the item.", "type": "integer" }, "entries": { "title": "Feedback entries linked to the item.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaFeedbackEntry5" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory34" } }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage14" } } }, "type": "object" }, "MediaFeedbackRoadmapItem2": { "properties": { "title": { "title": "Title of the roadmap item.", "type": "string" }, "description": { "title": "Description of the roadmap item.", "type": "string" }, "status": { "title": "Status of the item, for example planned, in progress or released.", "type": "string" }, "start_date": { "title": "Planned start date.", "type": "string", "format": "date-time" }, "target_date": { "title": "Planned release date.", "type": "string", "format": "date-time" }, "target_label": { "title": "Free-text period (\"Q3 2026\") for when a concrete date should not be promised. Shown\ninstead of targetDate when set.", "type": "string" }, "released_at": { "title": "Time the item was released.", "type": "string", "format": "date-time" }, "release_version": { "title": "Version the item was released in.", "type": "string" }, "image_url": { "title": "URL of the image of the item.", "type": "string" }, "sort_order": { "title": "Sort order of the item.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } } }, "type": "object" }, "MediaFeedbackRoadmapItem3": { "properties": { "timeline_order": { "title": "Position of this item's status group on the timeline. Unknown statuses sort last\ninstead of silently landing in the first group.", "type": "integer" }, "display_target": { "title": "What the timeline should print as the date of this milestone: the free-text label if\none was set, otherwise the target date.", "type": "string" }, "linked_entry_count": { "title": "Number of linked, still-visible feedback entries.", "type": "integer" }, "linked_vote_count": { "title": "Summed votes of all linked entries \u2014 the demand behind this milestone.", "type": "integer" }, "id": { "title": "Primary key of the roadmap item.", "description": "Internal ID.", "type": "integer" }, "title": { "title": "Title of the roadmap item.", "type": "string" }, "description": { "title": "Description of the roadmap item.", "type": "string" }, "status": { "title": "Status of the item, for example planned, in progress or released.", "type": "string" }, "start_date": { "title": "Planned start date.", "type": "string", "format": "date-time" }, "target_date": { "title": "Planned release date.", "type": "string", "format": "date-time" }, "target_label": { "title": "Free-text period (\"Q3 2026\") for when a concrete date should not be promised. Shown\ninstead of targetDate when set.", "type": "string" }, "released_at": { "title": "Time the item was released.", "type": "string", "format": "date-time" }, "release_version": { "title": "Version the item was released in.", "type": "string" }, "image_url": { "title": "URL of the image of the item.", "type": "string" }, "sort_order": { "title": "Sort order of the item.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory32" } }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage13" } } }, "type": "object" }, "MediaFeedbackSubscription": { "properties": { "id": { "title": "Primary key of the feedback subscription.", "description": "Internal ID.", "type": "integer" }, "entry": { "title": "Feedback entry the subscription belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry7" } ] }, "social_profile": { "title": "Profile of the subscriber.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "source": { "title": "Source of the subscription, for example the app or an e-mail.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaFeedbackVote": { "properties": { "id": { "title": "Primary key of the feedback vote.", "description": "Internal ID.", "type": "integer" }, "entry": { "title": "Feedback entry that was voted on.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaFeedbackEntry6" } ] }, "social_profile": { "title": "Profile that voted.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "voter_email": { "title": "Scope-only.", "type": "string" }, "voter_email_confirmed": { "title": "The e-mail address of the voter was confirmed.", "type": "boolean" }, "weight": { "title": "Weight of this vote. Always 1 for now; the column exists so weighting can be added\nwithout a data migration.", "type": "integer" }, "merged_from_entry_id": { "title": "Id of the entry this vote originally belonged to before a duplicate merge. Plain int,\nno foreign key \u2014 the source entry may be hard-deleted later and that must not cascade\ninto the merged vote.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaFileInfo": { "properties": { "id": { "title": "Primary key of the media file.", "description": "Internal ID.", "type": "integer" }, "media_file_type": { "title": "Type of the media file, for example audio, video or image.", "type": "string" }, "archived": { "title": "The file is archived.", "type": "boolean" }, "name": { "title": "internal name", "type": "string" }, "description": { "title": "internal description", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_link": { "title": "Public link to the file.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_description": { "title": "Description shown to the public.", "type": "string" }, "public_explicit": { "title": "The content is marked as explicit.", "type": "boolean" }, "public_thumbnail": { "title": "URL of the thumbnail.", "type": "string" }, "public_keywords": { "title": "Keywords of the file.", "type": "string" }, "public_file_url": { "title": "URL of the file.", "type": "string" }, "public_file_name": { "title": "Name of the file.", "type": "string" }, "public_file_mime": { "title": "MIME type of the file.", "type": "string" }, "public_file_size": { "title": "Size of the file in bytes.", "type": "integer" }, "public_duration": { "title": "Duration of audio or video in seconds.", "type": "integer" }, "public_dimension_x": { "title": "Width of the image or video in pixels.", "type": "integer" }, "public_dimension_y": { "title": "Height of the image or video in pixels.", "type": "integer" }, "public_date": { "title": "Publication date of the file.", "type": "string", "format": "date-time" }, "public_order": { "title": "Order of the file within its group.", "type": "integer" }, "public_episode_type": { "title": "Episode type for podcasts, for example full or trailer.", "type": "string" }, "public_season": { "title": "Season for podcasts.", "type": "string" }, "generated_id3": { "title": "ID3 tags were generated from the file.", "type": "boolean" }, "guid": { "title": "Global unique ID of the file, used in feeds.", "type": "string" }, "display_start_hour": { "title": "Hour from which the file is shown.", "type": "integer" }, "display_end_hour": { "title": "Hour until which the file is shown.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "MediaFileInfo2": { "properties": {}, "type": "object" }, "MediaFileInfo3": { "properties": { "id": { "title": "Primary key of the media file.", "description": "Internal ID.", "type": "integer" }, "media_file_type": { "title": "Type of the media file, for example audio, video or image.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_link": { "title": "Public link to the file.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_description": { "title": "Description shown to the public.", "type": "string" }, "public_explicit": { "title": "The content is marked as explicit.", "type": "boolean" }, "public_thumbnail": { "title": "URL of the thumbnail.", "type": "string" }, "public_keywords": { "title": "Keywords of the file.", "type": "string" }, "public_file_name": { "title": "Name of the file.", "type": "string" }, "public_file_mime": { "title": "MIME type of the file.", "type": "string" }, "public_file_size": { "title": "Size of the file in bytes.", "type": "integer" }, "public_duration": { "title": "Duration of audio or video in seconds.", "type": "integer" }, "public_dimension_x": { "title": "Width of the image or video in pixels.", "type": "integer" }, "public_dimension_y": { "title": "Height of the image or video in pixels.", "type": "integer" }, "public_date": { "title": "Publication date of the file.", "type": "string", "format": "date-time" }, "public_order": { "title": "Order of the file within its group.", "type": "integer" }, "public_episode_type": { "title": "Episode type for podcasts, for example full or trailer.", "type": "string" }, "public_season": { "title": "Season for podcasts.", "type": "string" }, "guid": { "title": "Global unique ID of the file, used in feeds.", "type": "string" }, "display_start_hour": { "title": "Hour from which the file is shown.", "type": "integer" }, "display_end_hour": { "title": "Hour until which the file is shown.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "MediaGroup": { "properties": { "id": { "title": "Primary key of the media group.", "description": "Internal ID.", "type": "integer" }, "group_type": { "title": "Type of the group, for example podcast or album.", "type": "string" }, "view_mode": { "title": "Display mode of the group, for example list or grid.", "type": "string" }, "token": { "title": "Public token of the group.", "description": "Used instead of the ID.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_link": { "title": "Public link to the group.", "type": "string" }, "public_link_rss": { "title": "Link to the RSS feed of the group.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the group.", "type": "string" }, "public_language_code": { "title": "Language of the group, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_description": { "title": "Description shown to the public.", "type": "string" }, "public_owner_name": { "title": "Owner name in the podcast feed.", "type": "string" }, "public_owner_mail": { "title": "Owner e-mail address in the podcast feed.", "type": "string" }, "public_explicit": { "title": "The content is marked as explicit.", "type": "boolean" }, "public_thumbnail": { "title": "URL of the cover image.", "type": "string" }, "public_keywords": { "title": "Keywords of the group.", "type": "string" }, "public_category": { "title": "Category of the group shown to the public.", "type": "string" }, "public_itunes_type": { "title": "Type in the iTunes feed, for example episodic or serial.", "type": "string" }, "public_guid": { "title": "Global unique ID of the group, used in feeds.", "type": "string" }, "auto_reload_time": { "title": "Time in seconds after which the group is reloaded automatically.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" }, "item_of_the_day": { "title": "This property is used to mark an entity as the item of the day.", "type": "boolean" } }, "type": "object" }, "MediaGroup2": { "properties": { "group_type": { "title": "Type of the group, for example podcast or album.", "type": "string" }, "view_mode": { "title": "Display mode of the group, for example list or grid.", "type": "string" }, "archived": { "title": "The group is archived.", "type": "boolean" }, "name": { "title": "Internal name of the group.", "type": "string" }, "description": { "title": "internal description", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_link": { "title": "Public link to the group.", "type": "string" }, "public_link_rss": { "title": "Link to the RSS feed of the group.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the group.", "type": "string" }, "public_language_code": { "title": "Language of the group, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_description": { "title": "Description shown to the public.", "type": "string" }, "public_owner_name": { "title": "Owner name in the podcast feed.", "type": "string" }, "public_owner_mail": { "title": "Owner e-mail address in the podcast feed.", "type": "string" }, "public_explicit": { "title": "The content is marked as explicit.", "type": "boolean" }, "public_thumbnail": { "title": "URL of the cover image.", "type": "string" }, "public_keywords": { "title": "Keywords of the group.", "type": "string" }, "public_category": { "title": "Category of the group shown to the public.", "type": "string" }, "public_itunes_type": { "title": "Type in the iTunes feed, for example episodic or serial.", "type": "string" }, "public_guid": { "title": "Global unique ID of the group, used in feeds.", "type": "string" }, "auto_reload_time": { "title": "Time in seconds after which the group is reloaded automatically.", "type": "integer" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" }, "item_of_the_day": { "title": "This property is used to mark an entity as the item of the day.", "type": "boolean" } }, "type": "object" }, "MediaGroup3": { "properties": { "id": { "title": "Primary key of the media group.", "description": "Internal ID.", "type": "integer" }, "group_type": { "title": "Type of the group, for example podcast or album.", "type": "string" }, "view_mode": { "title": "Display mode of the group, for example list or grid.", "type": "string" }, "token": { "title": "Public token of the group.", "description": "Used instead of the ID.", "type": "string" }, "archived": { "title": "The group is archived.", "type": "boolean" }, "name": { "title": "Internal name of the group.", "type": "string" }, "description": { "title": "internal description", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_link": { "title": "Public link to the group.", "type": "string" }, "public_link_rss": { "title": "Link to the RSS feed of the group.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the group.", "type": "string" }, "public_language_code": { "title": "Language of the group, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_description": { "title": "Description shown to the public.", "type": "string" }, "public_owner_name": { "title": "Owner name in the podcast feed.", "type": "string" }, "public_owner_mail": { "title": "Owner e-mail address in the podcast feed.", "type": "string" }, "public_explicit": { "title": "The content is marked as explicit.", "type": "boolean" }, "public_thumbnail": { "title": "URL of the cover image.", "type": "string" }, "public_keywords": { "title": "Keywords of the group.", "type": "string" }, "public_category": { "title": "Category of the group shown to the public.", "type": "string" }, "public_itunes_type": { "title": "Type in the iTunes feed, for example episodic or serial.", "type": "string" }, "public_guid": { "title": "Global unique ID of the group, used in feeds.", "type": "string" }, "auto_reload_time": { "title": "Time in seconds after which the group is reloaded automatically.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage3" } }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory22" } }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" }, "item_of_the_day": { "title": "This property is used to mark an entity as the item of the day.", "type": "boolean" } }, "type": "object" }, "MediaNewsArticle": { "properties": { "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace5" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true }, "unified_tag_ids": { "title": "IDs of the unified tags.", "type": "object", "additionalProperties": true }, "unified_tag_names": { "title": "Names of the unified tags.", "type": "object", "additionalProperties": true }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticle10": { "properties": { "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace13" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticle11": { "properties": { "news_type": { "title": "Type of the news article.", "type": "string" }, "entries": { "title": "Content blocks of the article.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticleContent6" } }, "name": { "title": "Internal name of the article.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace14" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "utags": { "title": "Unified tags of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag9" } }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "use_in_ai": { "title": "This property is used to mark an entity for syncing with a rag.", "type": "boolean" }, "only_personal_ai": { "title": "This property is used to only include the data for personal AI.", "type": "boolean" } }, "type": "object" }, "MediaNewsArticle12": { "properties": { "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace15" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticle13": { "properties": { "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace16" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage11" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticle2": { "properties": { "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace6" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true }, "unified_tag_ids": { "title": "IDs of the unified tags.", "type": "object", "additionalProperties": true }, "unified_tag_names": { "title": "Names of the unified tags.", "type": "object", "additionalProperties": true }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticle3": { "properties": { "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "name": { "title": "Internal name of the article.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace7" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage4" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory23" } }, "utags": { "title": "Unified tags of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag5" } }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticle4": { "properties": { "news_type": { "title": "Type of the news article.", "type": "string" }, "entries": { "title": "Content blocks of the article.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticleContent" } }, "name": { "title": "Internal name of the article.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace2" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "utags": { "title": "Unified tags of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag6" } }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "use_in_ai": { "title": "This property is used to mark an entity for syncing with a rag.", "type": "boolean" }, "only_personal_ai": { "title": "This property is used to only include the data for personal AI.", "type": "boolean" } }, "type": "object" }, "MediaNewsArticle5": { "properties": { "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "entries": { "title": "Content blocks of the article.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticleContent2" } }, "name": { "title": "Internal name of the article.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace8" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage5" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory24" } }, "utags": { "title": "Unified tags of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag7" } }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticle6": { "properties": { "content_html": { "type": "string" }, "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "entries": { "title": "Content blocks of the article.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticleContent3" } }, "name": { "title": "Internal name of the article.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace9" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage6" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory25" } }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true }, "utags": { "title": "Unified tags of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag8" } }, "unified_tag_ids": { "title": "IDs of the unified tags.", "type": "object", "additionalProperties": true }, "unified_tag_names": { "title": "Names of the unified tags.", "type": "object", "additionalProperties": true }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticle7": { "properties": { "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace10" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticle8": { "properties": { "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "entries": { "title": "Content blocks of the article.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticleContent2" } }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace11" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticle9": { "properties": { "content_html": { "type": "string" }, "id": { "title": "Primary key of the news article.", "description": "Internal ID.", "type": "integer" }, "news_type": { "title": "Type of the news article.", "type": "string" }, "token": { "title": "Public token of the article.", "description": "Used instead of the ID.", "type": "string" }, "entries": { "title": "Content blocks of the article.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaNewsArticleContent3" } }, "name": { "title": "Internal name of the article.", "type": "string" }, "public_title": { "title": "Title shown to the public.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the article.", "type": "string" }, "public_language_code": { "title": "Language of the article, for example de.", "type": "string" }, "public_subtitle": { "title": "Subtitle shown to the public.", "type": "string" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "public_summary": { "title": "Short summary shown to the public.", "type": "string" }, "public_thumbnail": { "title": "URL of the thumbnail image.", "type": "string" }, "public_keywords": { "title": "Keywords of the article.", "type": "string" }, "public_category": { "title": "Category of the article shown to the public.", "type": "string" }, "publish_date": { "title": "Time the article is published.", "type": "string", "format": "date-time" }, "unpublish_date": { "title": "Time the article is unpublished.", "type": "string", "format": "date-time" }, "article_space": { "title": "Article space the article belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaArticleSpace12" } ] }, "view_order": { "title": "Sort order of the article in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage7" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "highlight": { "title": "This property is used to mark an entity as highlighted", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory26" } }, "unified_cat_ids": { "title": "IDs of the unified categories.", "type": "object", "additionalProperties": true }, "unified_cat_names": { "title": "Names of the unified categories.", "type": "object", "additionalProperties": true }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaNewsArticleContent": { "properties": {}, "type": "object" }, "MediaNewsArticleContent2": { "properties": { "id": { "title": "Primary key of the news article content.", "description": "Internal ID.", "type": "integer" }, "content": { "title": "Content of the block.", "type": "string" }, "content_type": { "title": "Type of the block, for example text, image or video.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "MediaNewsArticleContent3": { "properties": { "content_html": { "type": "string" }, "id": { "title": "Primary key of the news article content.", "description": "Internal ID.", "type": "integer" }, "content": { "title": "Content of the block.", "type": "string" }, "content_type": { "title": "Type of the block, for example text, image or video.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "MediaNewsArticleContent6": { "properties": {}, "type": "object" }, "MediaNewsArticleDataType": { "properties": { "id": { "title": "Identifier of the news article data type.", "description": "For example news or press release.", "type": "string" }, "name": { "title": "Name of the news article type.", "type": "string" }, "show_admin": { "title": "Show the type in the admin app.", "type": "boolean" }, "show_customer": { "title": "Show the type in the customer app.", "type": "boolean" }, "menu_name": { "title": "Name of the menu entry for the type.", "type": "string" }, "show_admin_menu": { "title": "Show the type in the admin menu.", "type": "boolean" }, "show_customer_menu": { "title": "Show the type in the customer app menu.", "type": "boolean" }, "show_customer_description": { "title": "controls whether the customer news list shows the description below the headline", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "MediaQuestionnaire": { "properties": { "id": { "title": "Primary key of the questionnaire.", "description": "Internal ID.", "type": "integer" }, "questionnaire_type": { "title": "Type of the questionnaire, for example registration or survey.", "type": "string" }, "token": { "title": "Public token of the questionnaire.", "description": "Used instead of the ID.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the questionnaire.", "type": "string" }, "public_language_code": { "title": "Language of the questionnaire, for example de.", "type": "string" }, "complexity_level": { "title": "Complexity level of the questionnaire.", "type": "integer" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "show_free_text": { "title": "Show a free text field.", "type": "boolean" }, "show_attachment": { "title": "Show an upload field for attachments.", "type": "boolean" }, "require_attachment": { "title": "An attachment must be uploaded.", "type": "boolean" }, "with_pagination": { "title": "Show the questionnaire page by page.", "type": "boolean" }, "one_entry_per_person": { "title": "If true, only one entry per person is allowed - only for logged-in users and table results", "type": "boolean" }, "require_address": { "title": "The address must be entered.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered.", "type": "boolean" }, "require_age": { "title": "The age must be entered.", "type": "boolean" }, "require_grade_level": { "title": "The school grade level must be entered.", "type": "boolean" }, "start_time": { "title": "Start of the availability of the questionnaire.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the availability of the questionnaire.", "type": "string", "format": "date-time" }, "age_group": { "title": "Age group the questionnaire is intended for.", "type": "string" }, "min_age": { "title": "Minimum age in years.", "type": "integer" }, "max_age": { "title": "Maximum age in years.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level.", "type": "integer" }, "age_tolerance": { "title": "Years by which the age may be outside the range and still be accepted.", "type": "integer" }, "group_allowed": { "title": "Whether the questionnaire is limited to a group.", "type": "boolean" }, "allow_self_register": { "title": "Whether people can register themselves to answer the questionnaire.", "type": "boolean" }, "allow_self_download_result_template": { "title": "Whether answerers can download their own result.", "type": "boolean" }, "clarification_enabled": { "title": "Second loop after the AI comparison: answers the AI does not rate as fulfilled become clarification\npoints (MediaQuestionnaireClarification) that are discussed with the customer and decided before the\nresult template is created. Without it the result template follows the AI comparison directly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaQuestionnaire2": { "properties": { "id": { "title": "Primary key of the questionnaire.", "description": "Internal ID.", "type": "integer" }, "questionnaire_type": { "title": "Type of the questionnaire, for example registration or survey.", "type": "string" }, "token": { "title": "Public token of the questionnaire.", "description": "Used instead of the ID.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the questionnaire.", "type": "string" }, "public_language_code": { "title": "Language of the questionnaire, for example de.", "type": "string" }, "complexity_level": { "title": "Complexity level of the questionnaire.", "type": "integer" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "show_free_text": { "title": "Show a free text field.", "type": "boolean" }, "show_attachment": { "title": "Show an upload field for attachments.", "type": "boolean" }, "require_attachment": { "title": "An attachment must be uploaded.", "type": "boolean" }, "with_pagination": { "title": "Show the questionnaire page by page.", "type": "boolean" }, "one_entry_per_person": { "title": "If true, only one entry per person is allowed - only for logged-in users and table results", "type": "boolean" }, "require_address": { "title": "The address must be entered.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered.", "type": "boolean" }, "require_age": { "title": "The age must be entered.", "type": "boolean" }, "require_grade_level": { "title": "The school grade level must be entered.", "type": "boolean" }, "start_time": { "title": "Start of the availability of the questionnaire.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the availability of the questionnaire.", "type": "string", "format": "date-time" }, "pages": { "title": "Pages of the questionnaire.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnairePage" } }, "entries": { "title": "Questions and contents of the questionnaire.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireContent" } }, "notification_email": { "title": "Recipient(s) of the management notification mail sent on each new answer.", "description": "Multiple addresses can be provided comma-separated (e.g. \"a@x.de, b@y.de\").", "type": "string" }, "notification_text": { "title": "Short text of the notification sent after answering.", "type": "string" }, "notification_long_text": { "title": "Long text of the notification sent after answering.", "type": "string" }, "age_group": { "title": "Age group the questionnaire is intended for.", "type": "string" }, "min_age": { "title": "Minimum age in years.", "type": "integer" }, "max_age": { "title": "Maximum age in years.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level.", "type": "integer" }, "age_tolerance": { "title": "Years by which the age may be outside the range and still be accepted.", "type": "integer" }, "events": { "title": "Events the questionnaire belongs to.", "type": "array", "items": { "$ref": "#\/components\/schemas\/BaseEvent24" } }, "ai_chat_prompt": { "title": "The system prompt for the AI bot. The prompt will be suffixed by the MediaQuestionnaireContent in entries to give the AI a context of what questions we would like answers to at the end of the chat. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.", "type": "string" }, "ai_chat_optimizer_prompt": { "title": "The system prompt for the AI bot. The prompt will be used to optimize the chat prompt with existing context. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.", "type": "string" }, "ai_chat_auto_close_secret_word": { "title": "A word as the last part of an AI chat reply that will close the chat and trigger a completion of the questionnaire. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.", "type": "string" }, "ai_chat_completed_prompt": { "title": "The system prompt for the AI bot that takes all chat messages and the MediaQuestionnaireContent in entries to generate an answer to each of the questions. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.", "type": "string" }, "ai_answer_summary_prompt": { "title": "The system prompt for the AI bot that takes the answer to each question and generates a summary \/ wiki article of the answers. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.", "type": "string" }, "required_previous_questionnaire": { "title": "Questionnaire that must be answered first.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaire2" } ] }, "group_allowed": { "title": "Whether the questionnaire is limited to a group.", "type": "boolean" }, "allow_self_register": { "title": "Whether people can register themselves to answer the questionnaire.", "type": "boolean" }, "result_template": { "title": "Template used to render the result of the questionnaire.", "oneOf": [ { "$ref": "#\/components\/schemas\/FlexibleLatexTemplate" } ] }, "auto_send_result_template": { "title": "Whether the result is sent automatically after an answer is given.", "type": "boolean" }, "allow_self_download_result_template": { "title": "Whether answerers can download their own result.", "type": "boolean" }, "answer_product": { "title": "Product used for billing individual questionnaire answers", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem14" } ] }, "answer_group_product": { "title": "Product used for billing group questionnaire answers", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem14" } ] }, "auto_create_invoice": { "title": "If true, invoices are automatically created when answers are submitted", "type": "boolean" }, "ai_answer_features_enabled": { "title": "If true, AI features are enabled for the answers of this questionnaire", "type": "boolean" }, "clarification_enabled": { "title": "Second loop after the AI comparison: answers the AI does not rate as fulfilled become clarification\npoints (MediaQuestionnaireClarification) that are discussed with the customer and decided before the\nresult template is created. Without it the result template follows the AI comparison directly.", "type": "boolean" }, "ai_clarification_prompt": { "title": "Instructions for the AI that rates the compared answers and writes the clarification questions\n(tone, level of detail, standard to refer to). The answer format is fixed by the system.", "type": "string" }, "ai_clarification_evaluation_prompt": { "title": "Instructions for the AI that re-evaluates a clarification point with the response of the customer.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage9" } }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory27" } }, "name": { "title": "Name of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaQuestionnaire3": { "type": "object" }, "MediaQuestionnaire5": { "properties": { "id": { "title": "Primary key of the questionnaire.", "description": "Internal ID.", "type": "integer" }, "questionnaire_type": { "title": "Type of the questionnaire, for example registration or survey.", "type": "string" }, "token": { "title": "Public token of the questionnaire.", "description": "Used instead of the ID.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the questionnaire.", "type": "string" }, "public_language_code": { "title": "Language of the questionnaire, for example de.", "type": "string" }, "complexity_level": { "title": "Complexity level of the questionnaire.", "type": "integer" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "show_free_text": { "title": "Show a free text field.", "type": "boolean" }, "show_attachment": { "title": "Show an upload field for attachments.", "type": "boolean" }, "configuration_hints": { "title": "Not persisted: warnings about the installation setup this questionnaire depends on\n(e.g. AI comparison without LLM or OCR), filled for the admin detail response.", "type": "array", "items": { "type": "string" } }, "require_attachment": { "title": "An attachment must be uploaded.", "type": "boolean" }, "with_pagination": { "title": "Show the questionnaire page by page.", "type": "boolean" }, "one_entry_per_person": { "title": "If true, only one entry per person is allowed - only for logged-in users and table results", "type": "boolean" }, "require_address": { "title": "The address must be entered.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered.", "type": "boolean" }, "require_age": { "title": "The age must be entered.", "type": "boolean" }, "require_grade_level": { "title": "The school grade level must be entered.", "type": "boolean" }, "start_time": { "title": "Start of the availability of the questionnaire.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the availability of the questionnaire.", "type": "string", "format": "date-time" }, "pages": { "title": "Pages of the questionnaire.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnairePage" } }, "entries": { "title": "Questions and contents of the questionnaire.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireContent2" } }, "age_group": { "title": "Age group the questionnaire is intended for.", "type": "string" }, "min_age": { "title": "Minimum age in years.", "type": "integer" }, "max_age": { "title": "Maximum age in years.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level.", "type": "integer" }, "age_tolerance": { "title": "Years by which the age may be outside the range and still be accepted.", "type": "integer" }, "group_allowed": { "title": "Whether the questionnaire is limited to a group.", "type": "boolean" }, "allow_self_register": { "title": "Whether people can register themselves to answer the questionnaire.", "type": "boolean" }, "allow_self_download_result_template": { "title": "Whether answerers can download their own result.", "type": "boolean" }, "clarification_enabled": { "title": "Second loop after the AI comparison: answers the AI does not rate as fulfilled become clarification\npoints (MediaQuestionnaireClarification) that are discussed with the customer and decided before the\nresult template is created. Without it the result template follows the AI comparison directly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaQuestionnaire7": { "properties": { "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent14" }, "id": { "title": "Primary key of the questionnaire.", "description": "Internal ID.", "type": "integer" }, "questionnaire_type": { "title": "Type of the questionnaire, for example registration or survey.", "type": "string" }, "token": { "title": "Public token of the questionnaire.", "description": "Used instead of the ID.", "type": "string" }, "public_copyright": { "title": "Copyright text shown with the questionnaire.", "type": "string" }, "public_language_code": { "title": "Language of the questionnaire, for example de.", "type": "string" }, "complexity_level": { "title": "Complexity level of the questionnaire.", "type": "integer" }, "public_author": { "title": "Author shown to the public.", "type": "string" }, "show_free_text": { "title": "Show a free text field.", "type": "boolean" }, "show_attachment": { "title": "Show an upload field for attachments.", "type": "boolean" }, "require_attachment": { "title": "An attachment must be uploaded.", "type": "boolean" }, "with_pagination": { "title": "Show the questionnaire page by page.", "type": "boolean" }, "one_entry_per_person": { "title": "If true, only one entry per person is allowed - only for logged-in users and table results", "type": "boolean" }, "require_address": { "title": "The address must be entered.", "type": "boolean" }, "require_contact": { "title": "Contact details must be entered.", "type": "boolean" }, "require_age": { "title": "The age must be entered.", "type": "boolean" }, "require_grade_level": { "title": "The school grade level must be entered.", "type": "boolean" }, "start_time": { "title": "Start of the availability of the questionnaire.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the availability of the questionnaire.", "type": "string", "format": "date-time" }, "age_group": { "title": "Age group the questionnaire is intended for.", "type": "string" }, "min_age": { "title": "Minimum age in years.", "type": "integer" }, "max_age": { "title": "Maximum age in years.", "type": "integer" }, "min_grade_level": { "title": "Minimum school grade level.", "type": "integer" }, "max_grade_level": { "title": "Maximum school grade level.", "type": "integer" }, "age_tolerance": { "title": "Years by which the age may be outside the range and still be accepted.", "type": "integer" }, "group_allowed": { "title": "Whether the questionnaire is limited to a group.", "type": "boolean" }, "allow_self_register": { "title": "Whether people can register themselves to answer the questionnaire.", "type": "boolean" }, "allow_self_download_result_template": { "title": "Whether answerers can download their own result.", "type": "boolean" }, "clarification_enabled": { "title": "Second loop after the AI comparison: answers the AI does not rate as fulfilled become clarification\npoints (MediaQuestionnaireClarification) that are discussed with the customer and decided before the\nresult template is created. Without it the result template follows the AI comparison directly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswer": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the questionnaire answer.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "confirmed": { "title": "The answer is confirmed.", "type": "boolean" }, "draft": { "title": "The answer is a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answer is being processed.", "type": "boolean" }, "external": { "title": "The answer was given by an external party.", "type": "boolean" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "review_status": { "title": "Second loop after the AI comparison (MediaQuestionnaire::$clarificationEnabled), null without it:\nCLARIFICATION_PENDING while the comparison \/ the generation of the clarification points runs,\nCLARIFICATION_OPEN while points are open, COMPLETED once the review is finished and the result\ntemplate may be created.", "type": "string" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "role_in_company": { "title": "Role\/position of the respondent in the company", "type": "string" }, "start_in_company": { "title": "When the respondent started working at the company", "type": "string" }, "company_name": { "title": "When the respondent started working at the company", "type": "string" }, "answer_duration": { "title": "Duration in seconds the respondent took to complete the questionnaire", "type": "integer" }, "billed": { "title": "The answer was billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswer10": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the questionnaire answer.", "description": "Internal ID.", "type": "integer" }, "media_questionnaire": { "title": "Questionnaire that was answered.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaire5" } ] }, "media_questionnaire_answer_group": { "title": "Answer group the answer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup12" } ] }, "answers": { "title": "Answers to the content of the questionnaire.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireContentAnswer2" } }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "confirmed": { "title": "The answer is confirmed.", "type": "boolean" }, "draft": { "title": "The answer is a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answer is being processed.", "type": "boolean" }, "external": { "title": "The answer was given by an external party.", "type": "boolean" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "confirmed_disclaimer": { "title": "Disclaimer confirmed.", "type": "boolean" }, "confirmed_privacy": { "title": "Privacy policy confirmed.", "type": "boolean" }, "confirmed_cancellation_policy": { "title": "Cancellation policy confirmed.", "type": "boolean" }, "attachments": { "title": "Files attached to the answer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "event_sign_up": { "title": "Event sign-up the answer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp21" } ] }, "secondary_event_sign_up": { "title": "Second event sign-up the answer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp21" } ] }, "chatroom": { "title": "Chat room of the answer.", "oneOf": [ { "$ref": "#\/components\/schemas\/Chatroom10" } ] }, "exclude_from_statistic": { "title": "If true, this answer is excluded from statistics (e.g., flagged as malicious by admin)", "type": "boolean" }, "ai_comparison_result": { "title": "Result of the AI comparison with the expected answer.", "type": "boolean" }, "ai_comparison_remarks": { "title": "Remarks of the AI comparison.", "type": "string" }, "review_status": { "title": "Second loop after the AI comparison (MediaQuestionnaire::$clarificationEnabled), null without it:\nCLARIFICATION_PENDING while the comparison \/ the generation of the clarification points runs,\nCLARIFICATION_OPEN while points are open, COMPLETED once the review is finished and the result\ntemplate may be created.", "type": "string" }, "report_notes": { "title": "Additions of the auditor to the report (result template), e.g. a summary written after the review", "type": "string" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "role_in_company": { "title": "Role\/position of the respondent in the company", "type": "string" }, "start_in_company": { "title": "When the respondent started working at the company", "type": "string" }, "company_name": { "title": "When the respondent started working at the company", "type": "string" }, "answer_duration": { "title": "Duration in seconds the respondent took to complete the questionnaire", "type": "integer" }, "billed": { "title": "The answer was billed.", "type": "boolean" }, "invoices": { "title": "Invoices created for the answer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice29" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswer11": { "properties": { "id": { "title": "Primary key of the questionnaire answer.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "confirmed": { "title": "The answer is confirmed.", "type": "boolean" }, "draft": { "title": "The answer is a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answer is being processed.", "type": "boolean" }, "external": { "title": "The answer was given by an external party.", "type": "boolean" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "review_status": { "title": "Second loop after the AI comparison (MediaQuestionnaire::$clarificationEnabled), null without it:\nCLARIFICATION_PENDING while the comparison \/ the generation of the clarification points runs,\nCLARIFICATION_OPEN while points are open, COMPLETED once the review is finished and the result\ntemplate may be created.", "type": "string" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "role_in_company": { "title": "Role\/position of the respondent in the company", "type": "string" }, "start_in_company": { "title": "When the respondent started working at the company", "type": "string" }, "company_name": { "title": "When the respondent started working at the company", "type": "string" }, "answer_duration": { "title": "Duration in seconds the respondent took to complete the questionnaire", "type": "integer" }, "billed": { "title": "The answer was billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswer12": { "properties": { "id": { "title": "Primary key of the questionnaire answer.", "description": "Internal ID.", "type": "integer" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "confirmed": { "title": "The answer is confirmed.", "type": "boolean" }, "draft": { "title": "The answer is a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answer is being processed.", "type": "boolean" }, "external": { "title": "The answer was given by an external party.", "type": "boolean" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "review_status": { "title": "Second loop after the AI comparison (MediaQuestionnaire::$clarificationEnabled), null without it:\nCLARIFICATION_PENDING while the comparison \/ the generation of the clarification points runs,\nCLARIFICATION_OPEN while points are open, COMPLETED once the review is finished and the result\ntemplate may be created.", "type": "string" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "role_in_company": { "title": "Role\/position of the respondent in the company", "type": "string" }, "start_in_company": { "title": "When the respondent started working at the company", "type": "string" }, "company_name": { "title": "When the respondent started working at the company", "type": "string" }, "answer_duration": { "title": "Duration in seconds the respondent took to complete the questionnaire", "type": "integer" }, "billed": { "title": "The answer was billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswer17": { "properties": { "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "use_in_ai": { "title": "This property is used to mark an entity for syncing with a rag.", "type": "boolean" }, "only_personal_ai": { "title": "This property is used to only include the data for personal AI.", "type": "boolean" } }, "type": "object" }, "MediaQuestionnaireAnswer2": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the questionnaire answer.", "description": "Internal ID.", "type": "integer" }, "answers": { "title": "Answers to the content of the questionnaire.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireContentAnswer" } }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "confirmed": { "title": "The answer is confirmed.", "type": "boolean" }, "draft": { "title": "The answer is a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answer is being processed.", "type": "boolean" }, "external": { "title": "The answer was given by an external party.", "type": "boolean" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "confirmed_disclaimer": { "title": "Disclaimer confirmed.", "type": "boolean" }, "confirmed_privacy": { "title": "Privacy policy confirmed.", "type": "boolean" }, "confirmed_cancellation_policy": { "title": "Cancellation policy confirmed.", "type": "boolean" }, "attachments": { "title": "Files attached to the answer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "event_sign_up": { "title": "Event sign-up the answer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp19" } ] }, "secondary_event_sign_up": { "title": "Second event sign-up the answer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp19" } ] }, "review_status": { "title": "Second loop after the AI comparison (MediaQuestionnaire::$clarificationEnabled), null without it:\nCLARIFICATION_PENDING while the comparison \/ the generation of the clarification points runs,\nCLARIFICATION_OPEN while points are open, COMPLETED once the review is finished and the result\ntemplate may be created.", "type": "string" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "role_in_company": { "title": "Role\/position of the respondent in the company", "type": "string" }, "start_in_company": { "title": "When the respondent started working at the company", "type": "string" }, "company_name": { "title": "When the respondent started working at the company", "type": "string" }, "answer_duration": { "title": "Duration in seconds the respondent took to complete the questionnaire", "type": "integer" }, "billed": { "title": "The answer was billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswer3": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the questionnaire answer.", "description": "Internal ID.", "type": "integer" }, "media_questionnaire": { "title": "Questionnaire that was answered.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaire5" } ] }, "media_questionnaire_answer_group": { "title": "Answer group the answer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswerGroup11" } ] }, "answers": { "title": "Answers to the content of the questionnaire.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireContentAnswer2" } }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "confirmed": { "title": "The answer is confirmed.", "type": "boolean" }, "draft": { "title": "The answer is a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answer is being processed.", "type": "boolean" }, "external": { "title": "The answer was given by an external party.", "type": "boolean" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "confirmed_disclaimer": { "title": "Disclaimer confirmed.", "type": "boolean" }, "confirmed_privacy": { "title": "Privacy policy confirmed.", "type": "boolean" }, "confirmed_cancellation_policy": { "title": "Cancellation policy confirmed.", "type": "boolean" }, "attachments": { "title": "Files attached to the answer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "event_sign_up": { "title": "Event sign-up the answer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp20" } ] }, "secondary_event_sign_up": { "title": "Second event sign-up the answer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp20" } ] }, "chatroom": { "title": "Chat room of the answer.", "oneOf": [ { "$ref": "#\/components\/schemas\/Chatroom10" } ] }, "exclude_from_statistic": { "title": "If true, this answer is excluded from statistics (e.g., flagged as malicious by admin)", "type": "boolean" }, "ai_comparison_result": { "title": "Result of the AI comparison with the expected answer.", "type": "boolean" }, "ai_comparison_remarks": { "title": "Remarks of the AI comparison.", "type": "string" }, "review_status": { "title": "Second loop after the AI comparison (MediaQuestionnaire::$clarificationEnabled), null without it:\nCLARIFICATION_PENDING while the comparison \/ the generation of the clarification points runs,\nCLARIFICATION_OPEN while points are open, COMPLETED once the review is finished and the result\ntemplate may be created.", "type": "string" }, "report_notes": { "title": "Additions of the auditor to the report (result template), e.g. a summary written after the review", "type": "string" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "role_in_company": { "title": "Role\/position of the respondent in the company", "type": "string" }, "start_in_company": { "title": "When the respondent started working at the company", "type": "string" }, "company_name": { "title": "When the respondent started working at the company", "type": "string" }, "answer_duration": { "title": "Duration in seconds the respondent took to complete the questionnaire", "type": "integer" }, "billed": { "title": "The answer was billed.", "type": "boolean" }, "invoices": { "title": "Invoices created for the answer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice28" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswer5": { "properties": { "id": { "title": "Primary key of the questionnaire answer.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "confirmed": { "title": "The answer is confirmed.", "type": "boolean" }, "draft": { "title": "The answer is a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answer is being processed.", "type": "boolean" }, "external": { "title": "The answer was given by an external party.", "type": "boolean" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "attachments": { "title": "Files attached to the answer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment12" } }, "review_status": { "title": "Second loop after the AI comparison (MediaQuestionnaire::$clarificationEnabled), null without it:\nCLARIFICATION_PENDING while the comparison \/ the generation of the clarification points runs,\nCLARIFICATION_OPEN while points are open, COMPLETED once the review is finished and the result\ntemplate may be created.", "type": "string" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "role_in_company": { "title": "Role\/position of the respondent in the company", "type": "string" }, "start_in_company": { "title": "When the respondent started working at the company", "type": "string" }, "company_name": { "title": "When the respondent started working at the company", "type": "string" }, "answer_duration": { "title": "Duration in seconds the respondent took to complete the questionnaire", "type": "integer" }, "billed": { "title": "The answer was billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswer7": { "properties": { "id": { "title": "Primary key of the questionnaire answer.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "token": { "title": "Public token of the answer.", "description": "Used instead of the ID.", "type": "string" }, "confirmed": { "title": "The answer is confirmed.", "type": "boolean" }, "draft": { "title": "The answer is a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answer is being processed.", "type": "boolean" }, "external": { "title": "The answer was given by an external party.", "type": "boolean" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "attachments": { "title": "Files attached to the answer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment12" } }, "review_status": { "title": "Second loop after the AI comparison (MediaQuestionnaire::$clarificationEnabled), null without it:\nCLARIFICATION_PENDING while the comparison \/ the generation of the clarification points runs,\nCLARIFICATION_OPEN while points are open, COMPLETED once the review is finished and the result\ntemplate may be created.", "type": "string" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "role_in_company": { "title": "Role\/position of the respondent in the company", "type": "string" }, "start_in_company": { "title": "When the respondent started working at the company", "type": "string" }, "company_name": { "title": "When the respondent started working at the company", "type": "string" }, "answer_duration": { "title": "Duration in seconds the respondent took to complete the questionnaire", "type": "integer" }, "billed": { "title": "The answer was billed.", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswer8": { "properties": { "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "confirmed": { "title": "The answer is confirmed.", "type": "boolean" }, "draft": { "title": "The answer is a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answer is being processed.", "type": "boolean" }, "external": { "title": "The answer was given by an external party.", "type": "boolean" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "confirmed_disclaimer": { "title": "Disclaimer confirmed.", "type": "boolean" }, "confirmed_privacy": { "title": "Privacy policy confirmed.", "type": "boolean" }, "confirmed_cancellation_policy": { "title": "Cancellation policy confirmed.", "type": "boolean" }, "attachments": { "title": "Files attached to the answer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment12" } }, "report_notes": { "title": "Additions of the auditor to the report (result template), e.g. a summary written after the review", "type": "string" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "role_in_company": { "title": "Role\/position of the respondent in the company", "type": "string" }, "start_in_company": { "title": "When the respondent started working at the company", "type": "string" }, "company_name": { "title": "When the respondent started working at the company", "type": "string" }, "answer_duration": { "title": "Duration in seconds the respondent took to complete the questionnaire", "type": "integer" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswer9": { "properties": { "id": { "title": "Primary key of the questionnaire answer.", "description": "Internal ID.", "type": "integer" }, "first_name": { "title": "First name of the participant.", "type": "string" }, "last_name": { "title": "Last name of the participant.", "type": "string" }, "gender": { "title": "Gender of the participant.", "type": "string" }, "confirmed": { "title": "The answer is confirmed.", "type": "boolean" }, "draft": { "title": "The answer is a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answer is being processed.", "type": "boolean" }, "external": { "title": "The answer was given by an external party.", "type": "boolean" }, "birthday": { "title": "Birthday of the participant.", "type": "string", "format": "date-time" }, "known_allergies": { "title": "Known allergies of the participant.", "type": "string" }, "confirmed_no_allergies": { "title": "Guardian confirmed that there are no known allergies.", "type": "boolean" }, "grade_level": { "title": "School grade level of the participant.", "type": "integer" }, "school_class": { "title": "School class of the participant.", "type": "string" }, "attachments": { "title": "Files attached to the answer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment12" } }, "review_status": { "title": "Second loop after the AI comparison (MediaQuestionnaire::$clarificationEnabled), null without it:\nCLARIFICATION_PENDING while the comparison \/ the generation of the clarification points runs,\nCLARIFICATION_OPEN while points are open, COMPLETED once the review is finished and the result\ntemplate may be created.", "type": "string" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "role_in_company": { "title": "Role\/position of the respondent in the company", "type": "string" }, "start_in_company": { "title": "When the respondent started working at the company", "type": "string" }, "company_name": { "title": "When the respondent started working at the company", "type": "string" }, "answer_duration": { "title": "Duration in seconds the respondent took to complete the questionnaire", "type": "integer" }, "billed": { "title": "The answer was billed.", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswerGroup": { "properties": { "answer_count": { "type": "integer" }, "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the questionnaire answer group.", "description": "Internal ID.", "type": "integer" }, "answers": { "title": "Answers of the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer2" } }, "end_time": { "title": "Time the answers were completed.", "type": "string", "format": "date-time" }, "confirmed": { "title": "The answers are confirmed.", "type": "boolean" }, "draft": { "title": "The answers are a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answers are being processed.", "type": "boolean" }, "external": { "title": "The answers were given by an external party.", "type": "boolean" }, "confirmed_disclaimer": { "title": "Disclaimer confirmed.", "type": "boolean" }, "confirmed_privacy": { "title": "Privacy policy confirmed.", "type": "boolean" }, "confirmed_cancellation_policy": { "title": "Cancellation policy confirmed.", "type": "boolean" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "company_name": { "title": "Name of the company the answers were given for.", "type": "string" }, "billed": { "title": "The answers were billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswerGroup10": { "properties": { "answer_count": { "type": "integer" }, "id": { "title": "Primary key of the questionnaire answer group.", "description": "Internal ID.", "type": "integer" }, "end_time": { "title": "Time the answers were completed.", "type": "string", "format": "date-time" }, "confirmed": { "title": "The answers are confirmed.", "type": "boolean" }, "draft": { "title": "The answers are a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answers are being processed.", "type": "boolean" }, "external": { "title": "The answers were given by an external party.", "type": "boolean" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "company_name": { "title": "Name of the company the answers were given for.", "type": "string" }, "billed": { "title": "The answers were billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswerGroup11": { "properties": { "answer_count": { "type": "integer" }, "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the questionnaire answer group.", "description": "Internal ID.", "type": "integer" }, "media_questionnaire": { "title": "Questionnaire the answers belong to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaire5" } ] }, "answers": { "title": "Answers of the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer3" } }, "end_time": { "title": "Time the answers were completed.", "type": "string", "format": "date-time" }, "confirmed": { "title": "The answers are confirmed.", "type": "boolean" }, "draft": { "title": "The answers are a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answers are being processed.", "type": "boolean" }, "external": { "title": "The answers were given by an external party.", "type": "boolean" }, "confirmed_disclaimer": { "title": "Disclaimer confirmed.", "type": "boolean" }, "confirmed_privacy": { "title": "Privacy policy confirmed.", "type": "boolean" }, "confirmed_cancellation_policy": { "title": "Cancellation policy confirmed.", "type": "boolean" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "company_name": { "title": "Name of the company the answers were given for.", "type": "string" }, "billed": { "title": "The answers were billed.", "type": "boolean" }, "invoices": { "title": "Invoices created for the answers.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice28" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswerGroup12": { "properties": { "answer_count": { "type": "integer" }, "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the questionnaire answer group.", "description": "Internal ID.", "type": "integer" }, "media_questionnaire": { "title": "Questionnaire the answers belong to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaire5" } ] }, "answers": { "title": "Answers of the group.", "type": "array", "items": { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer10" } }, "end_time": { "title": "Time the answers were completed.", "type": "string", "format": "date-time" }, "confirmed": { "title": "The answers are confirmed.", "type": "boolean" }, "draft": { "title": "The answers are a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answers are being processed.", "type": "boolean" }, "external": { "title": "The answers were given by an external party.", "type": "boolean" }, "confirmed_disclaimer": { "title": "Disclaimer confirmed.", "type": "boolean" }, "confirmed_privacy": { "title": "Privacy policy confirmed.", "type": "boolean" }, "confirmed_cancellation_policy": { "title": "Cancellation policy confirmed.", "type": "boolean" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "company_name": { "title": "Name of the company the answers were given for.", "type": "string" }, "billed": { "title": "The answers were billed.", "type": "boolean" }, "invoices": { "title": "Invoices created for the answers.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice29" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswerGroup2": { "properties": { "answer_count": { "type": "integer" }, "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "person": { "$ref": "#\/components\/schemas\/CRMPerson10" }, "id": { "title": "Primary key of the questionnaire answer group.", "description": "Internal ID.", "type": "integer" }, "end_time": { "title": "Time the answers were completed.", "type": "string", "format": "date-time" }, "confirmed": { "title": "The answers are confirmed.", "type": "boolean" }, "draft": { "title": "The answers are a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answers are being processed.", "type": "boolean" }, "external": { "title": "The answers were given by an external party.", "type": "boolean" }, "nace_section": { "title": "NACE section code (letter A-U)", "type": "string" }, "nace_code": { "title": "NACE code (numeric like 01.11, 62.01)", "type": "string" }, "company_name": { "title": "Name of the company the answers were given for.", "type": "string" }, "billed": { "title": "The answers were billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswerGroup4": { "properties": { "answer_count": { "type": "integer" }, "id": { "title": "Primary key of the questionnaire answer group.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Public token of the answer group.", "description": "Used instead of the ID.", "type": "string" }, "end_time": { "title": "Time the answers were completed.", "type": "string", "format": "date-time" }, "confirmed": { "title": "The answers are confirmed.", "type": "boolean" }, "draft": { "title": "The answers are a draft and not yet submitted.", "type": "boolean" }, "processing": { "title": "The answers are being processed.", "type": "boolean" }, "billed": { "title": "The answers were billed.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "company_employee_count": { "title": "Number of employees of the company.", "type": "integer" }, "company_founding_year": { "title": "Founding year of the company.", "type": "integer" }, "company_family_owned": { "title": "Whether the company is family-owned.", "type": "boolean" }, "company_sales_volume": { "title": "Sales volume of the company.", "type": "string" }, "company_segment": { "title": "Market segment of the company.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireAnswerTest": { "properties": { "answer_allowed": { "title": "Whether answering is allowed.", "type": "boolean" }, "answer_delete_allowed": { "title": "Whether an answer may be deleted.", "type": "boolean" }, "answer_explicitly_disabled": { "title": "Whether answering is explicitly disabled.", "type": "boolean" }, "answer_require_add_bank_account": { "title": "Whether answering requires a bank account to be added first.", "type": "boolean" }, "answer_requires_login": { "title": "Whether answering requires a login.", "type": "boolean" }, "answer_require_add_access_tag": { "title": "Whether an access tag must be added before answering.", "type": "boolean" } }, "type": "object" }, "MediaQuestionnaireClarification": { "properties": { "media_questionnaire_answer_id": { "type": "integer" }, "content_answer_id": { "type": "integer" }, "id": { "title": "Primary key of the questionnaire clarification.", "description": "Internal ID.", "type": "integer" }, "content_key": { "title": "Stable key of the question (MediaQuestionnaireContent::$contentKey), copied from the content answer", "type": "string" }, "title": { "title": "Title of the question, copied from the content answer (or a free title for manual points)", "type": "string" }, "source": { "title": "AI or MANUAL", "type": "string" }, "ai_verdict": { "title": "Rating of the AI after the comparison: PASSED, NEEDS_CLARIFICATION, FAILED, NOT_APPLICABLE (null if the AI gave none)", "type": "string" }, "ai_score": { "title": "Degree of fulfilment 0-100 given by the AI", "type": "integer" }, "ai_reasoning": { "title": "Why the AI rated the answer this way (what is missing)", "type": "string" }, "question": { "title": "The question to ask the customer (generated by the AI, editable)", "type": "string" }, "response": { "title": "What the customer answered (notes of the interview)", "type": "string" }, "status": { "title": "OPEN, ANSWERED, RESOLVED, DISMISSED", "type": "string" }, "processing": { "title": "True while the AI re-evaluates the point", "type": "boolean" }, "ai_suggested_verdict": { "title": "Suggestion of the AI re-evaluation (response and late evidence included)", "type": "string" }, "ai_suggestion_reasoning": { "title": "Reasoning of the AI suggestion for the clarification.", "type": "string" }, "final_verdict": { "title": "Decision of the auditor: PASSED, FAILED, NOT_APPLICABLE", "type": "string" }, "auditor_note": { "title": "Note of the auditor for the report", "type": "string" }, "decided_at": { "title": "Time the clarification was decided.", "type": "string", "format": "date-time" }, "decided_by": { "title": "Name of the user who decided the point", "type": "string" }, "attachments": { "title": "Late evidence handed in during the clarification", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "view_order": { "title": "Sort order of the clarification in lists.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaQuestionnaireClarification2": { "properties": { "media_questionnaire_answer": { "title": "Answer the clarification is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireAnswer17" } ] }, "content_answer": { "title": "The answered question this point is about. Null for general points of the auditor.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaQuestionnaireContentAnswer4" } ] }, "title": { "title": "Title of the question, copied from the content answer (or a free title for manual points)", "type": "string" }, "ai_verdict": { "title": "Rating of the AI after the comparison: PASSED, NEEDS_CLARIFICATION, FAILED, NOT_APPLICABLE (null if the AI gave none)", "type": "string" }, "ai_score": { "title": "Degree of fulfilment 0-100 given by the AI", "type": "integer" }, "ai_reasoning": { "title": "Why the AI rated the answer this way (what is missing)", "type": "string" }, "question": { "title": "The question to ask the customer (generated by the AI, editable)", "type": "string" }, "response": { "title": "What the customer answered (notes of the interview)", "type": "string" }, "status": { "title": "OPEN, ANSWERED, RESOLVED, DISMISSED", "type": "string" }, "final_verdict": { "title": "Decision of the auditor: PASSED, FAILED, NOT_APPLICABLE", "type": "string" }, "auditor_note": { "title": "Note of the auditor for the report", "type": "string" }, "view_order": { "title": "Sort order of the clarification in lists.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaQuestionnaireContent": { "properties": { "id": { "title": "Primary key of the questionnaire content.", "description": "Internal ID.", "type": "integer" }, "content": { "title": "Question or text of the content.", "type": "string" }, "content_key": { "title": "Stable key of the question: never changes once set (text, type and position may change),\nunique within the questionnaire and copied to MediaQuestionnaireContentAnswer::$contentKey.", "description": "Filled by MediaQuestionnaireContentKeyListener.", "type": "string" }, "content_hint": { "title": "Hint for the answer.", "type": "string" }, "content_filter": { "title": "Filter of the content, for example which answers are allowed.", "type": "string" }, "public_title": { "title": "Title of the content shown to the public.", "type": "string" }, "answer": { "title": "Given answer", "type": "string" }, "answer_list": { "title": "Answer list for dropdowns or radio buttons. Divided by new line. Inner values divided by | to separate value and label", "type": "string" }, "answer_required": { "title": "If true, the answer is required", "type": "boolean" }, "previous_answer_required": { "title": "If true, the question is only shown if the previous question was answered", "type": "boolean" }, "previous_answer_reference": { "title": "Reference to the previous answer content", "type": "string" }, "answer_in_title": { "title": "If true, the answer is added to the title", "type": "boolean" }, "answer_in_table": { "title": "If true, the answer is added to the result table (if available)", "type": "boolean" }, "page_number": { "title": "Page of the questionnaire the content is on.", "type": "integer" }, "content_type": { "title": "Type of the content, for example text, choice or upload.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "MediaQuestionnaireContent2": { "properties": { "id": { "title": "Primary key of the questionnaire content.", "description": "Internal ID.", "type": "integer" }, "content": { "title": "Question or text of the content.", "type": "string" }, "content_key": { "title": "Stable key of the question: never changes once set (text, type and position may change),\nunique within the questionnaire and copied to MediaQuestionnaireContentAnswer::$contentKey.", "description": "Filled by MediaQuestionnaireContentKeyListener.", "type": "string" }, "content_hint": { "title": "Hint for the answer.", "type": "string" }, "content_filter": { "title": "Filter of the content, for example which answers are allowed.", "type": "string" }, "public_title": { "title": "Title of the content shown to the public.", "type": "string" }, "answer": { "title": "Given answer", "type": "string" }, "answer_list": { "title": "Answer list for dropdowns or radio buttons. Divided by new line. Inner values divided by | to separate value and label", "type": "string" }, "answer_required": { "title": "If true, the answer is required", "type": "boolean" }, "previous_answer_required": { "title": "If true, the question is only shown if the previous question was answered", "type": "boolean" }, "previous_answer_reference": { "title": "Reference to the previous answer content", "type": "string" }, "answer_in_title": { "title": "If true, the answer is added to the title", "type": "boolean" }, "answer_in_table": { "title": "If true, the answer is added to the result table (if available)", "type": "boolean" }, "page_number": { "title": "Page of the questionnaire the content is on.", "type": "integer" }, "content_type": { "title": "Type of the content, for example text, choice or upload.", "type": "string" }, "content_ai_group": { "title": "Group used for the AI comparison of answers.", "type": "string" }, "ai_comparison_prompt": { "title": "Prompt for the AI comparison of the answer.", "type": "string" }, "ai_comparison_document": { "title": "Document the AI uses to compare the answer.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "MediaQuestionnaireContentAnswer": { "properties": { "id": { "title": "Primary key of the content answer.", "description": "Internal ID.", "type": "integer" }, "content": { "title": "Text of the answer.", "type": "string" }, "content_key": { "title": "Stable key of the answered question (MediaQuestionnaireContent::$contentKey)", "type": "string" }, "content_hint": { "title": "Hint for the answer.", "type": "string" }, "content_filter": { "title": "Filter of the content, for example which answers are allowed.", "type": "string" }, "public_title": { "title": "Title of the content shown to the public.", "type": "string" }, "answer": { "title": "Given answer", "type": "string" }, "answer_list": { "title": "Answer list for dropdowns or radio buttons. Divided by new line. Inner values divided by | to separate value and label", "type": "string" }, "answer_required": { "title": "If true, the answer is required", "type": "boolean" }, "previous_answer_required": { "title": "If true, the question is only shown if the previous question was answered", "type": "boolean" }, "previous_answer_reference": { "title": "Reference to the previous answer content", "type": "string" }, "answer_in_title": { "title": "If true, the answer is added to the title", "type": "boolean" }, "answer_in_table": { "title": "If true, the answer is added to the result table (if available)", "type": "boolean" }, "page_number": { "title": "Page of the questionnaire the content is on.", "type": "integer" }, "content_type": { "title": "Type of the content, for example text, choice or upload.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireContentAnswer2": { "properties": { "id": { "title": "Primary key of the content answer.", "description": "Internal ID.", "type": "integer" }, "content": { "title": "Text of the answer.", "type": "string" }, "content_key": { "title": "Stable key of the answered question (MediaQuestionnaireContent::$contentKey)", "type": "string" }, "content_hint": { "title": "Hint for the answer.", "type": "string" }, "content_filter": { "title": "Filter of the content, for example which answers are allowed.", "type": "string" }, "public_title": { "title": "Title of the content shown to the public.", "type": "string" }, "answer": { "title": "Given answer", "type": "string" }, "ai_result": { "title": "Result generated by the AI comparison pipeline for this answer.", "type": "string" }, "answer_list": { "title": "Answer list for dropdowns or radio buttons. Divided by new line. Inner values divided by | to separate value and label", "type": "string" }, "answer_required": { "title": "If true, the answer is required", "type": "boolean" }, "previous_answer_required": { "title": "If true, the question is only shown if the previous question was answered", "type": "boolean" }, "previous_answer_reference": { "title": "Reference to the previous answer content", "type": "string" }, "answer_in_title": { "title": "If true, the answer is added to the title", "type": "boolean" }, "answer_in_table": { "title": "If true, the answer is added to the result table (if available)", "type": "boolean" }, "page_number": { "title": "Page of the questionnaire the content is on.", "type": "integer" }, "content_type": { "title": "Type of the content, for example text, choice or upload.", "type": "string" } }, "type": "object" }, "MediaQuestionnaireContentAnswer4": { "type": "object" }, "MediaQuestionnairePage": { "properties": { "id": { "title": "Primary key of the questionnaire page.", "description": "Internal ID.", "type": "integer" }, "page_number": { "title": "Number of the page within the questionnaire.", "type": "integer" }, "page_progress_status": { "title": "Progress status shown for the page.", "type": "string" }, "answer_required": { "title": "If true, at least one answer is required", "type": "boolean" }, "previous_answer_required": { "title": "If true, the page is only shown if the previous question was answered", "type": "boolean" }, "previous_answer_reference": { "title": "Reference to the previous answer content", "type": "string" }, "content_hint": { "title": "Hint text shown on the page.", "type": "string" }, "submenu_title": { "title": "Title of the submenu entry for the page.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "MediaSocialModerationTrigger": { "properties": { "pattern": { "title": "Pattern that triggers the moderation, for example a word or expression.", "type": "string" }, "trigger_type": { "title": "Type of the trigger, for example keyword or link.", "type": "string" }, "description": { "title": "Description of the trigger.", "type": "string" }, "active": { "title": "The trigger is active.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialModerationTrigger2": { "properties": { "id": { "title": "Primary key of the moderation trigger.", "description": "Internal ID.", "type": "integer" }, "pattern": { "title": "Pattern that triggers the moderation, for example a word or expression.", "type": "string" }, "trigger_type": { "title": "Type of the trigger, for example keyword or link.", "type": "string" }, "description": { "title": "Description of the trigger.", "type": "string" }, "active": { "title": "The trigger is active.", "type": "boolean" }, "source": { "title": "Source of the trigger, for example the admin or the AI check.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPost": { "properties": { "url_image": { "title": "Proxy URL that resolves to this post's image. Returns null until a preview has been\nextracted and an imageToken is assigned.", "type": "string" }, "id": { "title": "Primary key of the social post.", "description": "Internal ID.", "type": "integer" }, "headline": { "title": "Headline of the post.", "type": "string" }, "text": { "title": "Text of the post.", "type": "string" }, "url": { "title": "Link in the post.", "type": "string" }, "url_title": { "title": "Title of the link in the post.", "type": "string" }, "url_source_image": { "title": "Raw origin URL of the preview image. Stored as scope-only; never exposed directly\nto non-admin callers \u2014 use the virtual url_image property instead.", "type": "string" }, "image_token": { "title": "Server-assigned, never accepted from API input \u2014 omitted from oaInput groups on purpose.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderation_reason": { "title": "Reason for the moderation decision.", "type": "string" }, "moderated_manually": { "title": "True once a moderator decided about this entry by hand. Automatic decisions - a\ntrigger match on creation, the batch auto-approve - leave it false, and that is what\nlets member reports push an entry back into moderation later on.", "type": "boolean" }, "report_count": { "title": "Number of distinct members who reported this entry. Moderators only.", "type": "integer" }, "moderated_at": { "title": "Time the post was moderated.", "type": "string", "format": "date-time" }, "social_profile": { "title": "Profile that wrote the post.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "attachments": { "title": "Files attached to the post.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "base_event": { "title": "Event the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent25" } ] }, "base_booking": { "title": "Booking the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "base_bookable": { "title": "Bookable the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookable16" } ] }, "news_article": { "title": "News article the post is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaNewsArticle10" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPost10": { "properties": { "url_image": { "title": "Proxy URL that resolves to this post's image. Returns null until a preview has been\nextracted and an imageToken is assigned.", "type": "string" }, "id": { "title": "Primary key of the social post.", "description": "Internal ID.", "type": "integer" }, "headline": { "title": "Headline of the post.", "type": "string" }, "text": { "title": "Text of the post.", "type": "string" }, "url": { "title": "Link in the post.", "type": "string" }, "url_title": { "title": "Title of the link in the post.", "type": "string" }, "url_source_image": { "title": "Raw origin URL of the preview image. Stored as scope-only; never exposed directly\nto non-admin callers \u2014 use the virtual url_image property instead.", "type": "string" }, "image_token": { "title": "Server-assigned, never accepted from API input \u2014 omitted from oaInput groups on purpose.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderated_manually": { "title": "True once a moderator decided about this entry by hand. Automatic decisions - a\ntrigger match on creation, the batch auto-approve - leave it false, and that is what\nlets member reports push an entry back into moderation later on.", "type": "boolean" }, "report_count": { "title": "Number of distinct members who reported this entry. Moderators only.", "type": "integer" }, "social_profile": { "title": "Profile that wrote the post.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPost2": { "properties": { "headline": { "title": "Headline of the post.", "type": "string" }, "text": { "title": "Text of the post.", "type": "string" }, "url": { "title": "Link in the post.", "type": "string" }, "url_title": { "title": "Title of the link in the post.", "type": "string" }, "url_source_image": { "title": "Raw origin URL of the preview image. Stored as scope-only; never exposed directly\nto non-admin callers \u2014 use the virtual url_image property instead.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderation_reason": { "title": "Reason for the moderation decision.", "type": "string" }, "social_profile": { "title": "Profile that wrote the post.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile16" } ] }, "attachments": { "title": "Files attached to the post.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment12" } }, "base_event": { "title": "Event the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent26" } ] }, "base_booking": { "title": "Booking the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking24" } ] }, "base_bookable": { "title": "Bookable the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookable17" } ] }, "news_article": { "title": "News article the post is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaNewsArticle11" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } } }, "type": "object" }, "MediaSocialPost3": { "properties": { "url_image": { "title": "Proxy URL that resolves to this post's image. Returns null until a preview has been\nextracted and an imageToken is assigned.", "type": "string" }, "id": { "title": "Primary key of the social post.", "description": "Internal ID.", "type": "integer" }, "headline": { "title": "Headline of the post.", "type": "string" }, "text": { "title": "Text of the post.", "type": "string" }, "url": { "title": "Link in the post.", "type": "string" }, "url_title": { "title": "Title of the link in the post.", "type": "string" }, "url_source_image": { "title": "Raw origin URL of the preview image. Stored as scope-only; never exposed directly\nto non-admin callers \u2014 use the virtual url_image property instead.", "type": "string" }, "image_token": { "title": "Server-assigned, never accepted from API input \u2014 omitted from oaInput groups on purpose.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderation_reason": { "title": "Reason for the moderation decision.", "type": "string" }, "moderated_manually": { "title": "True once a moderator decided about this entry by hand. Automatic decisions - a\ntrigger match on creation, the batch auto-approve - leave it false, and that is what\nlets member reports push an entry back into moderation later on.", "type": "boolean" }, "report_count": { "title": "Number of distinct members who reported this entry. Moderators only.", "type": "integer" }, "moderated_at": { "title": "Time the post was moderated.", "type": "string", "format": "date-time" }, "social_profile": { "title": "Profile that wrote the post.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "attachments": { "title": "Files attached to the post.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "base_event": { "title": "Event the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent25" } ] }, "base_booking": { "title": "Booking the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "base_bookable": { "title": "Bookable the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookable16" } ] }, "news_article": { "title": "News article the post is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaNewsArticle12" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPost4": { "properties": { "url_image": { "title": "Proxy URL that resolves to this post's image. Returns null until a preview has been\nextracted and an imageToken is assigned.", "type": "string" }, "id": { "title": "Primary key of the social post.", "description": "Internal ID.", "type": "integer" }, "headline": { "title": "Headline of the post.", "type": "string" }, "text": { "title": "Text of the post.", "type": "string" }, "url": { "title": "Link in the post.", "type": "string" }, "url_title": { "title": "Title of the link in the post.", "type": "string" }, "url_source_image": { "title": "Raw origin URL of the preview image. Stored as scope-only; never exposed directly\nto non-admin callers \u2014 use the virtual url_image property instead.", "type": "string" }, "image_token": { "title": "Server-assigned, never accepted from API input \u2014 omitted from oaInput groups on purpose.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderation_reason": { "title": "Reason for the moderation decision.", "type": "string" }, "moderated_manually": { "title": "True once a moderator decided about this entry by hand. Automatic decisions - a\ntrigger match on creation, the batch auto-approve - leave it false, and that is what\nlets member reports push an entry back into moderation later on.", "type": "boolean" }, "report_count": { "title": "Number of distinct members who reported this entry. Moderators only.", "type": "integer" }, "moderated_at": { "title": "Time the post was moderated.", "type": "string", "format": "date-time" }, "social_profile": { "title": "Profile that wrote the post.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "attachments": { "title": "Files attached to the post.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "base_event": { "title": "Event the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent28" } ] }, "base_booking": { "title": "Booking the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "base_bookable": { "title": "Bookable the post is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookable19" } ] }, "news_article": { "title": "News article the post is linked to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaNewsArticle13" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "visibility_type": { "title": "Type of visibility of the entity.", "type": "string" }, "arslist": { "title": "Access rights list that controls the visibility.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage11" } } }, "type": "object" }, "MediaSocialPost6": { "properties": { "headline": { "title": "Headline of the post.", "type": "string" }, "text": { "title": "Text of the post.", "type": "string" }, "url": { "title": "Link in the post.", "type": "string" }, "url_title": { "title": "Title of the link in the post.", "type": "string" }, "url_source_image": { "title": "Raw origin URL of the preview image. Stored as scope-only; never exposed directly\nto non-admin callers \u2014 use the virtual url_image property instead.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } } }, "type": "object" }, "MediaSocialPostComment": { "properties": { "id": { "title": "Primary key of the social post comment.", "description": "Internal ID.", "type": "integer" }, "text": { "title": "Text of the comment.", "type": "string" }, "url": { "title": "Link in the comment.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderation_reason": { "title": "Reason for the moderation decision.", "type": "string" }, "moderated_manually": { "title": "True once a moderator decided about this entry by hand. Automatic decisions - a\ntrigger match on creation, the batch auto-approve - leave it false, and that is what\nlets member reports push an entry back into moderation later on.", "type": "boolean" }, "report_count": { "title": "Number of distinct members who reported this entry. Moderators only.", "type": "integer" }, "moderated_at": { "title": "Time the comment was moderated.", "type": "string", "format": "date-time" }, "social_post": { "title": "Post the comment belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialPost10" } ] }, "social_profile": { "title": "Profile that wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPostComment2": { "properties": { "text": { "title": "Text of the comment.", "type": "string" }, "url": { "title": "Link in the comment.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderation_reason": { "title": "Reason for the moderation decision.", "type": "string" }, "social_post": { "title": "Post the comment belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialPost6" } ] }, "social_profile": { "title": "Profile that wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile16" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPostComment4": { "properties": { "id": { "title": "Primary key of the social post comment.", "description": "Internal ID.", "type": "integer" }, "text": { "title": "Text of the comment.", "type": "string" }, "url": { "title": "Link in the comment.", "type": "string" }, "moderation_status": { "title": "Moderation status, for example pending or approved.", "type": "string" }, "moderated_manually": { "title": "True once a moderator decided about this entry by hand. Automatic decisions - a\ntrigger match on creation, the batch auto-approve - leave it false, and that is what\nlets member reports push an entry back into moderation later on.", "type": "boolean" }, "report_count": { "title": "Number of distinct members who reported this entry. Moderators only.", "type": "integer" }, "social_profile": { "title": "Profile that wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPostComment5": { "properties": { "text": { "title": "Text of the comment.", "type": "string" }, "url": { "title": "Link in the comment.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPostCommentReaction": { "properties": { "id": { "title": "Primary key of the comment reaction.", "description": "Internal ID.", "type": "integer" }, "emoji": { "title": "Emoji of the reaction.", "type": "string" }, "comment": { "title": "Comment the reaction belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialPostComment4" } ] }, "social_profile": { "title": "Profile that reacted.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPostCommentReaction2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPostReaction": { "properties": { "id": { "title": "Primary key of the post reaction.", "description": "Internal ID.", "type": "integer" }, "emoji": { "title": "Emoji of the reaction.", "type": "string" }, "social_post": { "title": "Post the reaction belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialPost10" } ] }, "social_profile": { "title": "Profile that reacted.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialPostReaction2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialProfile": { "properties": { "public_name": { "title": "Name shown publicly.", "type": "string" }, "profile_picture_url": { "title": "URL of the profile picture.", "type": "string" }, "public_about_me": { "title": "Text about the person shown publicly.", "type": "string" }, "person": { "title": "Person the profile belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson71" } ] }, "name_display_type": { "title": "How the name is shown, for example full name or first name only.", "type": "string" }, "show_profile_picture": { "title": "The profile picture is shown.", "type": "boolean" }, "profile_picture_check_status": { "title": "Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper):\nnull = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes\nBild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialProfile10": { "properties": { "id": { "title": "Primary key of the social profile.", "description": "Internal ID.", "type": "integer" }, "public_name": { "title": "Name shown publicly.", "type": "string" }, "profile_picture_url": { "title": "URL of the profile picture.", "type": "string" }, "public_about_me": { "title": "Text about the person shown publicly.", "type": "string" }, "global_profile": { "title": "The profile is a global profile across installations.", "type": "boolean" }, "name_display_type": { "title": "How the name is shown, for example full name or first name only.", "type": "string" }, "show_profile_picture": { "title": "The profile picture is shown.", "type": "boolean" }, "profile_picture_check_status": { "title": "Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper):\nnull = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes\nBild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialProfile16": { "properties": { "public_name": { "title": "Name shown publicly.", "type": "string" }, "profile_picture_url": { "title": "URL of the profile picture.", "type": "string" }, "public_about_me": { "title": "Text about the person shown publicly.", "type": "string" }, "name_display_type": { "title": "How the name is shown, for example full name or first name only.", "type": "string" }, "show_profile_picture": { "title": "The profile picture is shown.", "type": "boolean" }, "profile_picture_check_status": { "title": "Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper):\nnull = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes\nBild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialProfile18": { "type": "object" }, "MediaSocialProfile2": { "properties": { "id": { "title": "Primary key of the social profile.", "description": "Internal ID.", "type": "integer" }, "public_name": { "title": "Name shown publicly.", "type": "string" }, "profile_picture_url": { "title": "URL of the profile picture.", "type": "string" }, "public_about_me": { "title": "Text about the person shown publicly.", "type": "string" }, "person": { "title": "Person the profile belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "global_profile": { "title": "The profile is a global profile across installations.", "type": "boolean" }, "name_display_type": { "title": "How the name is shown, for example full name or first name only.", "type": "string" }, "show_profile_picture": { "title": "The profile picture is shown.", "type": "boolean" }, "profile_picture_check_status": { "title": "Pruefstatus des Profilbilds (KI-Pruefung, siehe MediaSocialProfilePictureHelper):\nnull = nie geprueft (Pruefung aus), pending, approved, rejected. Nur ein freigegebenes\nBild landet in profilePictureUrl, solange die Pruefung eingeschaltet ist.", "type": "string" }, "profile_picture_check_reason": { "title": "Begruendung der Pruefung (KI-Einschaetzung bzw. Hinweis fuer das Team).", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialProfile23": { "type": "object" }, "MediaSocialReport": { "properties": { "id": { "title": "Primary key of the social report.", "description": "Internal ID.", "type": "integer" }, "reason": { "title": "Free-text reason given by the reporter. Optional.", "type": "string" }, "social_post": { "title": "Reported post.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialPost10" } ] }, "comment": { "title": "Reported comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialPostComment4" } ] }, "social_profile": { "title": "The reporting member.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialProfile10" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MediaSocialReport2": { "properties": { "reason": { "title": "Free-text reason given by the reporter. Optional.", "type": "string" }, "social_post": { "title": "Reported post.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialPost6" } ] }, "comment": { "title": "Reported comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/MediaSocialPostComment5" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "MembershipFeeRuleSet": { "properties": { "rule_count": { "title": "Number of rules (for lists)", "type": "integer" }, "id": { "title": "Primary key of the fee rule set.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "Only active rule sets are used", "type": "boolean" }, "valid_from": { "title": "The rule set applies from this date on (null: always)", "type": "string", "format": "date-time" }, "adult_age": { "title": "From this age on a person counts as adult (role \"adult\"), younger as child", "type": "integer" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "MembershipPauseRequest": { "properties": { "days": { "type": "integer" }, "log_book_entry": { "type": "integer" }, "membership_name": { "type": "string" }, "person": { "type": "integer" }, "person_name": { "type": "string" }, "company": { "type": "integer" }, "decided_by_user_name": { "type": "string" }, "id": { "title": "Primary key of the membership pause request.", "description": "Internal ID.", "type": "integer" }, "start": { "title": "First day of the pause.", "type": "string", "format": "date-time" }, "end": { "title": "Last day of the pause (the whole day is included).", "type": "string", "format": "date-time" }, "reason": { "title": "Reason for the pause.", "type": "string" }, "status": { "title": "Status of the request, for example open, approved or rejected.", "type": "string" }, "decided_at": { "title": "Time the request was decided.", "type": "string", "format": "date-time" }, "decision_comment": { "title": "Comment on the decision.", "type": "string" }, "applied_at": { "title": "When the pause was written into the membership.", "type": "string", "format": "date-time" }, "withdrawn_at": { "title": "Time the request was withdrawn.", "type": "string", "format": "date-time" }, "extended_end": { "title": "The membership end the pause set (only when the settings extend the membership).", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "MessengerMessage": { "properties": { "id": { "title": "Primary key of the messenger message.", "description": "Internal ID.", "type": "integer" }, "direction": { "title": "outbound | inbound", "type": "string" }, "channel": { "title": "sms | whatsapp", "type": "string" }, "provider": { "title": "INFOBIP | SINCH | CM", "type": "string" }, "phone_number": { "title": "E.164 digits without + of the person (recipient or sender)", "type": "string" }, "template_name": { "title": "WhatsApp template used outside the service window", "type": "string" }, "status": { "title": "sent | failed | received", "type": "string" }, "error_message": { "title": "Error message if sending failed.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "MessengerMessage2": { "properties": { "id": { "title": "Primary key of the messenger message.", "description": "Internal ID.", "type": "integer" }, "direction": { "title": "outbound | inbound", "type": "string" }, "channel": { "title": "sms | whatsapp", "type": "string" }, "provider": { "title": "INFOBIP | SINCH | CM", "type": "string" }, "phone_number": { "title": "E.164 digits without + of the person (recipient or sender)", "type": "string" }, "template_name": { "title": "WhatsApp template used outside the service window", "type": "string" }, "status": { "title": "sent | failed | received", "type": "string" }, "provider_message_id": { "title": "ID of the message at the messenger provider.", "type": "string" }, "error_message": { "title": "Error message if sending failed.", "type": "string" }, "user_notification": { "title": "User notification the message belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/UserNotification" } ] }, "chatroom": { "title": "Chat room the message belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Chatroom10" } ] }, "chatroom_message": { "title": "Chat room message the messenger message belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ChatroomMessage4" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NaceCode": { "properties": { "id": { "title": "Primary key of the NACE code.", "description": "Internal ID.", "type": "integer" }, "code": { "title": "NACE code of the economic activity.", "type": "string" }, "level": { "title": "Hierarchy level of the code.", "type": "integer" }, "parent_code": { "title": "Code of the parent entry in the hierarchy.", "type": "string" }, "isic_reference": { "title": "Corresponding ISIC code.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "NaceCode2": { "properties": { "code": { "title": "NACE code of the economic activity.", "type": "string" }, "level": { "title": "Hierarchy level of the code.", "type": "integer" }, "parent_code": { "title": "Code of the parent entry in the hierarchy.", "type": "string" }, "isic_reference": { "title": "Corresponding ISIC code.", "type": "string" } }, "type": "object" }, "NonWorkTimeAnnualRequest": { "properties": { "id": { "title": "Primary key of the annual request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "year": { "title": "The vacation year the periods belong to.", "type": "integer" }, "content_type": { "title": "Absence type of every period (NonWorkTimePlanSelectionType value).", "type": "integer" }, "description": { "title": "Description of the annual request.", "type": "string" }, "status": { "title": "Derived from the periods, see class comment.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeAnnualRequest2": { "properties": { "person": { "title": "Person the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson38" } ] }, "contract": { "title": "Employment contract the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract10" } ] }, "year": { "title": "The vacation year the periods belong to.", "type": "integer" }, "content_type": { "title": "Absence type of every period (NonWorkTimePlanSelectionType value).", "type": "integer" }, "description": { "title": "Description of the annual request.", "type": "string" } }, "type": "object" }, "NonWorkTimeAnnualRequest3": { "properties": { "id": { "title": "Primary key of the annual request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "contract": { "title": "Employment contract the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract11" } ] }, "created_by_user": { "title": "User who created the annual request.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "year": { "title": "The vacation year the periods belong to.", "type": "integer" }, "content_type": { "title": "Absence type of every period (NonWorkTimePlanSelectionType value).", "type": "integer" }, "description": { "title": "Description of the annual request.", "type": "string" }, "status": { "title": "Derived from the periods, see class comment.", "type": "string" }, "requests": { "title": "Non-work time requests created from the annual request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest6" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeAnnualRequest4": { "properties": { "id": { "title": "Primary key of the annual request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "year": { "title": "The vacation year the periods belong to.", "type": "integer" }, "content_type": { "title": "Absence type of every period (NonWorkTimePlanSelectionType value).", "type": "integer" }, "description": { "title": "Description of the annual request.", "type": "string" }, "status": { "title": "Derived from the periods, see class comment.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeAnnualRequest5": { "type": "object" }, "NonWorkTimeAnnualRequest6": { "properties": { "id": { "title": "Primary key of the annual request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "year": { "title": "The vacation year the periods belong to.", "type": "integer" }, "content_type": { "title": "Absence type of every period (NonWorkTimePlanSelectionType value).", "type": "integer" }, "description": { "title": "Description of the annual request.", "type": "string" }, "status": { "title": "Derived from the periods, see class comment.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeAnnualRequest7": { "properties": { "id": { "title": "Primary key of the annual request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "contract": { "title": "Employment contract the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract18" } ] }, "created_by_user": { "title": "User who created the annual request.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "year": { "title": "The vacation year the periods belong to.", "type": "integer" }, "content_type": { "title": "Absence type of every period (NonWorkTimePlanSelectionType value).", "type": "integer" }, "description": { "title": "Description of the annual request.", "type": "string" }, "status": { "title": "Derived from the periods, see class comment.", "type": "string" }, "requests": { "title": "Non-work time requests created from the annual request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest4" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeAnnualRequest8": { "properties": { "id": { "title": "Primary key of the annual request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "contract": { "title": "Employment contract the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract5" } ] }, "created_by_user": { "title": "User who created the annual request.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "year": { "title": "The vacation year the periods belong to.", "type": "integer" }, "content_type": { "title": "Absence type of every period (NonWorkTimePlanSelectionType value).", "type": "integer" }, "description": { "title": "Description of the annual request.", "type": "string" }, "status": { "title": "Derived from the periods, see class comment.", "type": "string" }, "requests": { "title": "Non-work time requests created from the annual request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest5" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeAnnualRequest9": { "properties": { "id": { "title": "Primary key of the annual request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "contract": { "title": "Employment contract the annual request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract19" } ] }, "created_by_user": { "title": "User who created the annual request.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "year": { "title": "The vacation year the periods belong to.", "type": "integer" }, "content_type": { "title": "Absence type of every period (NonWorkTimePlanSelectionType value).", "type": "integer" }, "description": { "title": "Description of the annual request.", "type": "string" }, "status": { "title": "Derived from the periods, see class comment.", "type": "string" }, "requests": { "title": "Non-work time requests created from the annual request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeRequest7" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeBlockingPeriod": { "properties": { "level": { "title": "How narrow the period is. The narrowest level with a matching period decides, so a\nsingle contract can carry an exception without touching the group or organization\nrule it sits under.", "type": "integer" }, "id": { "title": "Primary key of the blocking period.", "description": "Internal ID.", "type": "integer" }, "start": { "title": "First blocked day (inclusive).", "type": "string", "format": "date-time" }, "end": { "title": "Last blocked day (inclusive) - a one day block has start = end.", "type": "string", "format": "date-time" }, "mode": { "title": "Mode of the blocking period, for example block or warn.", "type": "string" }, "scope": { "title": "Scope of the blocking period, for example group or contract.", "type": "string" }, "max_days_per_year": { "title": "Days per calendar year that may still be taken inside this period before it decides\nanything at all. null keeps the period absolute - the previous and still default\nbehaviour. A value turns the period from a wall into an allowance: \"at most seven\ndays outside the school holidays\" is one period over the whole year with a quota of\nseven, not seven separate rules.", "type": "integer" }, "quota_scope": { "title": "Which days inside the period count towards the quota. Only meaningful together with\nmaxDaysPerYear.", "type": "string" }, "requires_consultation": { "title": "Days this period counts (e.g. outside school holidays) may only be requested after a\nconsultation with the responsible team lead; the request has to name it (U14).", "type": "boolean" }, "cancellation_quota_days": { "title": "U21: how many already approved absence days a person may withdraw again inside this\nperiod per year (e.g. two days of the summer closure). null = no limit.", "type": "integer" }, "cancellation_requires_written_approval": { "title": "U21: withdrawing approved days inside this period needs the written decision of the\nmanagement step (comment mandatory).", "type": "boolean" }, "employment_organization": { "title": "All three references empty means the period applies to everyone.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization" } ] }, "employment_contract_group": { "title": "Contract group the blocking period applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "contract": { "title": "Contract the blocking period applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeBlockingPeriod2": { "properties": { "start": { "title": "First blocked day (inclusive).", "type": "string", "format": "date-time" }, "end": { "title": "Last blocked day (inclusive) - a one day block has start = end.", "type": "string", "format": "date-time" }, "mode": { "title": "Mode of the blocking period, for example block or warn.", "type": "string" }, "scope": { "title": "Scope of the blocking period, for example group or contract.", "type": "string" }, "max_days_per_year": { "title": "Days per calendar year that may still be taken inside this period before it decides\nanything at all. null keeps the period absolute - the previous and still default\nbehaviour. A value turns the period from a wall into an allowance: \"at most seven\ndays outside the school holidays\" is one period over the whole year with a quota of\nseven, not seven separate rules.", "type": "integer" }, "quota_scope": { "title": "Which days inside the period count towards the quota. Only meaningful together with\nmaxDaysPerYear.", "type": "string" }, "requires_consultation": { "title": "Days this period counts (e.g. outside school holidays) may only be requested after a\nconsultation with the responsible team lead; the request has to name it (U14).", "type": "boolean" }, "cancellation_quota_days": { "title": "U21: how many already approved absence days a person may withdraw again inside this\nperiod per year (e.g. two days of the summer closure). null = no limit.", "type": "integer" }, "cancellation_requires_written_approval": { "title": "U21: withdrawing approved days inside this period needs the written decision of the\nmanagement step (comment mandatory).", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "NonWorkTimeBlockingPeriod3": { "properties": { "level": { "title": "How narrow the period is. The narrowest level with a matching period decides, so a\nsingle contract can carry an exception without touching the group or organization\nrule it sits under.", "type": "integer" }, "id": { "title": "Primary key of the blocking period.", "description": "Internal ID.", "type": "integer" }, "start": { "title": "First blocked day (inclusive).", "type": "string", "format": "date-time" }, "end": { "title": "Last blocked day (inclusive) - a one day block has start = end.", "type": "string", "format": "date-time" }, "mode": { "title": "Mode of the blocking period, for example block or warn.", "type": "string" }, "scope": { "title": "Scope of the blocking period, for example group or contract.", "type": "string" }, "max_days_per_year": { "title": "Days per calendar year that may still be taken inside this period before it decides\nanything at all. null keeps the period absolute - the previous and still default\nbehaviour. A value turns the period from a wall into an allowance: \"at most seven\ndays outside the school holidays\" is one period over the whole year with a quota of\nseven, not seven separate rules.", "type": "integer" }, "quota_scope": { "title": "Which days inside the period count towards the quota. Only meaningful together with\nmaxDaysPerYear.", "type": "string" }, "requires_consultation": { "title": "Days this period counts (e.g. outside school holidays) may only be requested after a\nconsultation with the responsible team lead; the request has to name it (U14).", "type": "boolean" }, "cancellation_quota_days": { "title": "U21: how many already approved absence days a person may withdraw again inside this\nperiod per year (e.g. two days of the summer closure). null = no limit.", "type": "integer" }, "cancellation_requires_written_approval": { "title": "U21: withdrawing approved days inside this period needs the written decision of the\nmanagement step (comment mandatory).", "type": "boolean" }, "employment_organization": { "title": "All three references empty means the period applies to everyone.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization2" } ] }, "employment_contract_group": { "title": "Contract group the blocking period applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "contract": { "title": "Contract the blocking period applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract2" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimePlan": { "type": "object" }, "NonWorkTimePlan2": { "properties": { "id": { "title": "Primary key of the absence plan entry.", "description": "Internal ID.", "type": "integer" } }, "type": "object" }, "NonWorkTimePlanSelectionType": { "properties": { "effective_color": { "title": "The colour to show: the configured one, else the default of the type.", "type": "string" }, "id": { "title": "Primary key of the absence type.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the absence type, for example vacation or sick leave.", "type": "string" }, "value": { "title": "Numeric value of the absence type.", "type": "integer" }, "priority": { "title": "Priority of the absence type when several types overlap.", "type": "integer" }, "processed_content_type": { "title": "Content type used when the absence is processed.", "type": "string" }, "secondary_content_type_options": { "title": "Options for the secondary content type, separated by a comma", "type": "string" }, "icon": { "title": "Icon of the absence type.", "type": "string" }, "is_vacation": { "title": "The absence type counts as vacation.", "type": "boolean" }, "is_sick": { "title": "The absence type counts as sick leave.", "type": "boolean" }, "status_change_requires_hr_approval": { "title": "Changing the status of this absence type requires HR approval.", "type": "boolean" }, "selectable_for_request": { "title": "Whether a new absence request may be created with this type. Types that only\ndescribe a day in an overview - holiday, school holiday, work day - are not\noffered in the editors.", "type": "boolean" }, "requires_management_approval": { "title": "Requests of this type need a final written decision by the management (the\norganization leadership), appended after the regular approval chain (U10).", "type": "boolean" }, "max_days_per_request": { "title": "Upper limit of calendar days one request of this type may cover; null = unlimited.", "type": "integer" }, "color": { "title": "R5: colour of this absence type in the shift plan and the team calendar (\"#RRGGBB\");\nnull = the default of the type (getEffectiveColor). Used with absence_type_colors_enabled.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "NonWorkTimePlanSelectionType2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "NonWorkTimePlanSelectionType3": { "properties": { "effective_color": { "title": "The colour to show: the configured one, else the default of the type.", "type": "string" }, "name": { "title": "Name of the absence type, for example vacation or sick leave.", "type": "string" }, "value": { "title": "Numeric value of the absence type.", "type": "integer" }, "priority": { "title": "Priority of the absence type when several types overlap.", "type": "integer" }, "processed_content_type": { "title": "Content type used when the absence is processed.", "type": "string" }, "secondary_content_type_options": { "title": "Options for the secondary content type, separated by a comma", "type": "string" }, "icon": { "title": "Icon of the absence type.", "type": "string" }, "is_vacation": { "title": "The absence type counts as vacation.", "type": "boolean" }, "is_sick": { "title": "The absence type counts as sick leave.", "type": "boolean" }, "status_change_requires_hr_approval": { "title": "Changing the status of this absence type requires HR approval.", "type": "boolean" }, "selectable_for_request": { "title": "Whether a new absence request may be created with this type. Types that only\ndescribe a day in an overview - holiday, school holiday, work day - are not\noffered in the editors.", "type": "boolean" }, "requires_management_approval": { "title": "Requests of this type need a final written decision by the management (the\norganization leadership), appended after the regular approval chain (U10).", "type": "boolean" }, "max_days_per_request": { "title": "Upper limit of calendar days one request of this type may cover; null = unlimited.", "type": "integer" }, "color": { "title": "R5: colour of this absence type in the shift plan and the team calendar (\"#RRGGBB\");\nnull = the default of the type (getEffectiveColor). Used with absence_type_colors_enabled.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "NonWorkTimeRequest": { "properties": { "overdue": { "title": "U04: still waiting after the processing deadline.", "type": "boolean" }, "approval_version": { "title": "Version of the approval process.", "type": "integer" }, "change_mode": { "title": "Mode of a change to the request.", "type": "string" }, "balance_override_reason": { "title": "L11: why a planner approved this request although the projected vacation balance was negative.", "type": "string" }, "coverage_override_reason": { "title": "L54: why the approver accepted a day below the minimum staffing.", "type": "string" }, "coverage_hint": { "title": "L53: handed in although it eats into the staffing buffer - the approvers see the hint.", "type": "boolean" }, "sick_during_vacation": { "title": "U13: a sick report inside approved vacation - set by the server, shown as \"w\u00e4hrend Urlaub\".", "type": "boolean" }, "consultation_note": { "title": "Who was consulted before requesting days a blocking period marks as consultation-only (U14).", "type": "string" }, "daily_absence_start_time": { "title": "Local daily absence window for half-day types; null preserves legacy planning.", "type": "string" }, "daily_absence_end_time": { "title": "End time of daily absence.", "type": "string" }, "id": { "title": "Primary key of the request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Description of the request.", "type": "string" }, "start": { "title": "Start of the requested period.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the requested period.", "type": "string" }, "start_month": { "title": "Start month of the requested period.", "type": "integer" }, "start_year": { "title": "Start year of the requested period.", "type": "integer" }, "end": { "title": "End of the requested period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End date of the requested period.", "type": "string" }, "end_month": { "title": "End month of the requested period.", "type": "integer" }, "end_year": { "title": "End year of the requested period.", "type": "integer" }, "duration": { "title": "duration in days linked to NonWorkTimePlan - a half day type counts 0.5 (Z6)", "type": "number", "format": "float" }, "status": { "title": "Status of the request.", "type": "string" }, "content_type": { "title": "Type of the request, e.g. vacation or absence.", "type": "string" }, "secondary_content_type": { "title": "Secondary type of the request.", "type": "string" }, "linked_content_type": { "title": "Plan selection type linked to the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType3" } ] }, "parent_request": { "title": "The request this one changes (\"\u00c4nderungsantrag zum Jahresurlaub\"). A change request\nis an ordinary request in every other respect; the reference is what turns a second,\nunrelated looking request into a visible correction of the first - and what lets the\ndays it withdraws be marked as withdrawn instead of merely refused.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeRequest" } ] }, "annual_request": { "title": "L47\/L48: the annual plan (\"Jahresurlaubsantrag\") this period belongs to. The bundle\nis decided as a whole; the period stays an ordinary request in every other respect.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest4" } ] }, "request_kind": { "title": "U02\/U18: ANNUAL = period of the annual plan, SUPPLEMENT = Erg\u00e4nzungsantrag for the\nheld back flexible days. null = ordinary request.", "type": "string" }, "processing_due_date": { "title": "U04\/U20: the day by which the request has to be decided, counted from its receipt.", "type": "string", "format": "date-time" }, "escalated_at": { "title": "U04: when the overdue escalation was sent; null = not (yet) escalated.", "type": "string", "format": "date-time" }, "written_approval_reason": { "title": "U21: why the management step with a written comment was added to this request\n(e.g. SUMMER_CANCELLATION); null = no extra written approval needed.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeRequest2": { "properties": { "change_mode": { "title": "Mode of a change to the request.", "type": "string" }, "daily_absence_start_time": { "title": "Local daily absence window for half-day types; null preserves legacy planning.", "type": "string" }, "daily_absence_end_time": { "title": "End time of daily absence.", "type": "string" }, "person": { "title": "Person the request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson37" } ] }, "contract": { "title": "Employment contract the request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract8" } ] }, "description": { "title": "Description of the request.", "type": "string" }, "start": { "title": "Start of the requested period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the requested period.", "type": "string", "format": "date-time" }, "status": { "title": "Status of the request.", "type": "string" }, "content_type": { "title": "Type of the request, e.g. vacation or absence.", "type": "string" }, "secondary_content_type": { "title": "Secondary type of the request.", "type": "string" }, "attachments": { "title": "Attachments of the request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment12" } }, "comments": { "title": "Comments on the request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment3" } }, "plan_entries": { "title": "Plan entries generated for the request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimePlan" } }, "parent_request": { "title": "The request this one changes (\"\u00c4nderungsantrag zum Jahresurlaub\"). A change request\nis an ordinary request in every other respect; the reference is what turns a second,\nunrelated looking request into a visible correction of the first - and what lets the\ndays it withdraws be marked as withdrawn instead of merely refused.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeRequest2" } ] }, "annual_request": { "title": "L47\/L48: the annual plan (\"Jahresurlaubsantrag\") this period belongs to. The bundle\nis decided as a whole; the period stays an ordinary request in every other respect.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest5" } ] }, "request_kind": { "title": "U02\/U18: ANNUAL = period of the annual plan, SUPPLEMENT = Erg\u00e4nzungsantrag for the\nheld back flexible days. null = ordinary request.", "type": "string" } }, "type": "object" }, "NonWorkTimeRequest3": { "properties": { "overdue": { "title": "U04: still waiting after the processing deadline.", "type": "boolean" }, "approval_version": { "title": "Version of the approval process.", "type": "integer" }, "change_mode": { "title": "Mode of a change to the request.", "type": "string" }, "balance_override_reason": { "title": "L11: why a planner approved this request although the projected vacation balance was negative.", "type": "string" }, "coverage_override_reason": { "title": "L54: why the approver accepted a day below the minimum staffing.", "type": "string" }, "coverage_hint": { "title": "L53: handed in although it eats into the staffing buffer - the approvers see the hint.", "type": "boolean" }, "sick_during_vacation": { "title": "U13: a sick report inside approved vacation - set by the server, shown as \"w\u00e4hrend Urlaub\".", "type": "boolean" }, "consultation_note": { "title": "Who was consulted before requesting days a blocking period marks as consultation-only (U14).", "type": "string" }, "daily_absence_start_time": { "title": "Local daily absence window for half-day types; null preserves legacy planning.", "type": "string" }, "daily_absence_end_time": { "title": "End time of daily absence.", "type": "string" }, "id": { "title": "Primary key of the request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "contract": { "title": "Employment contract the request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract9" } ] }, "description": { "title": "Description of the request.", "type": "string" }, "start": { "title": "Start of the requested period.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the requested period.", "type": "string" }, "start_month": { "title": "Start month of the requested period.", "type": "integer" }, "start_year": { "title": "Start year of the requested period.", "type": "integer" }, "end": { "title": "End of the requested period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End date of the requested period.", "type": "string" }, "end_month": { "title": "End month of the requested period.", "type": "integer" }, "end_year": { "title": "End year of the requested period.", "type": "integer" }, "duration": { "title": "duration in days linked to NonWorkTimePlan - a half day type counts 0.5 (Z6)", "type": "number", "format": "float" }, "status": { "title": "Status of the request.", "type": "string" }, "content_type": { "title": "Type of the request, e.g. vacation or absence.", "type": "string" }, "secondary_content_type": { "title": "Secondary type of the request.", "type": "string" }, "linked_content_type": { "title": "Plan selection type linked to the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType3" } ] }, "attachments": { "title": "Attachments of the request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "comments": { "title": "Comments on the request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment4" } }, "plan_entries": { "title": "Plan entries generated for the request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimePlan2" } }, "parent_request": { "title": "The request this one changes (\"\u00c4nderungsantrag zum Jahresurlaub\"). A change request\nis an ordinary request in every other respect; the reference is what turns a second,\nunrelated looking request into a visible correction of the first - and what lets the\ndays it withdraws be marked as withdrawn instead of merely refused.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeRequest3" } ] }, "annual_request": { "title": "L47\/L48: the annual plan (\"Jahresurlaubsantrag\") this period belongs to. The bundle\nis decided as a whole; the period stays an ordinary request in every other respect.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest6" } ] }, "request_kind": { "title": "U02\/U18: ANNUAL = period of the annual plan, SUPPLEMENT = Erg\u00e4nzungsantrag for the\nheld back flexible days. null = ordinary request.", "type": "string" }, "processing_due_date": { "title": "U04\/U20: the day by which the request has to be decided, counted from its receipt.", "type": "string", "format": "date-time" }, "escalated_at": { "title": "U04: when the overdue escalation was sent; null = not (yet) escalated.", "type": "string", "format": "date-time" }, "written_approval_reason": { "title": "U21: why the management step with a written comment was added to this request\n(e.g. SUMMER_CANCELLATION); null = no extra written approval needed.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeRequest4": { "properties": { "overdue": { "title": "U04: still waiting after the processing deadline.", "type": "boolean" }, "approval_version": { "title": "Version of the approval process.", "type": "integer" }, "change_mode": { "title": "Mode of a change to the request.", "type": "string" }, "balance_override_reason": { "title": "L11: why a planner approved this request although the projected vacation balance was negative.", "type": "string" }, "coverage_override_reason": { "title": "L54: why the approver accepted a day below the minimum staffing.", "type": "string" }, "coverage_hint": { "title": "L53: handed in although it eats into the staffing buffer - the approvers see the hint.", "type": "boolean" }, "sick_during_vacation": { "title": "U13: a sick report inside approved vacation - set by the server, shown as \"w\u00e4hrend Urlaub\".", "type": "boolean" }, "consultation_note": { "title": "Who was consulted before requesting days a blocking period marks as consultation-only (U14).", "type": "string" }, "daily_absence_start_time": { "title": "Local daily absence window for half-day types; null preserves legacy planning.", "type": "string" }, "daily_absence_end_time": { "title": "End time of daily absence.", "type": "string" }, "id": { "title": "Primary key of the request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Description of the request.", "type": "string" }, "start": { "title": "Start of the requested period.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the requested period.", "type": "string" }, "start_month": { "title": "Start month of the requested period.", "type": "integer" }, "start_year": { "title": "Start year of the requested period.", "type": "integer" }, "end": { "title": "End of the requested period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End date of the requested period.", "type": "string" }, "end_month": { "title": "End month of the requested period.", "type": "integer" }, "end_year": { "title": "End year of the requested period.", "type": "integer" }, "duration": { "title": "duration in days linked to NonWorkTimePlan - a half day type counts 0.5 (Z6)", "type": "number", "format": "float" }, "status": { "title": "Status of the request.", "type": "string" }, "content_type": { "title": "Type of the request, e.g. vacation or absence.", "type": "string" }, "secondary_content_type": { "title": "Secondary type of the request.", "type": "string" }, "linked_content_type": { "title": "Plan selection type linked to the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType3" } ] }, "parent_request": { "title": "The request this one changes (\"\u00c4nderungsantrag zum Jahresurlaub\"). A change request\nis an ordinary request in every other respect; the reference is what turns a second,\nunrelated looking request into a visible correction of the first - and what lets the\ndays it withdraws be marked as withdrawn instead of merely refused.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeRequest4" } ] }, "annual_request": { "title": "L47\/L48: the annual plan (\"Jahresurlaubsantrag\") this period belongs to. The bundle\nis decided as a whole; the period stays an ordinary request in every other respect.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest7" } ] }, "request_kind": { "title": "U02\/U18: ANNUAL = period of the annual plan, SUPPLEMENT = Erg\u00e4nzungsantrag for the\nheld back flexible days. null = ordinary request.", "type": "string" }, "processing_due_date": { "title": "U04\/U20: the day by which the request has to be decided, counted from its receipt.", "type": "string", "format": "date-time" }, "escalated_at": { "title": "U04: when the overdue escalation was sent; null = not (yet) escalated.", "type": "string", "format": "date-time" }, "written_approval_reason": { "title": "U21: why the management step with a written comment was added to this request\n(e.g. SUMMER_CANCELLATION); null = no extra written approval needed.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeRequest5": { "properties": { "overdue": { "title": "U04: still waiting after the processing deadline.", "type": "boolean" }, "approval_version": { "title": "Version of the approval process.", "type": "integer" }, "change_mode": { "title": "Mode of a change to the request.", "type": "string" }, "balance_override_reason": { "title": "L11: why a planner approved this request although the projected vacation balance was negative.", "type": "string" }, "coverage_override_reason": { "title": "L54: why the approver accepted a day below the minimum staffing.", "type": "string" }, "coverage_hint": { "title": "L53: handed in although it eats into the staffing buffer - the approvers see the hint.", "type": "boolean" }, "sick_during_vacation": { "title": "U13: a sick report inside approved vacation - set by the server, shown as \"w\u00e4hrend Urlaub\".", "type": "boolean" }, "consultation_note": { "title": "Who was consulted before requesting days a blocking period marks as consultation-only (U14).", "type": "string" }, "daily_absence_start_time": { "title": "Local daily absence window for half-day types; null preserves legacy planning.", "type": "string" }, "daily_absence_end_time": { "title": "End time of daily absence.", "type": "string" }, "id": { "title": "Primary key of the request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Description of the request.", "type": "string" }, "start": { "title": "Start of the requested period.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the requested period.", "type": "string" }, "start_month": { "title": "Start month of the requested period.", "type": "integer" }, "start_year": { "title": "Start year of the requested period.", "type": "integer" }, "end": { "title": "End of the requested period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End date of the requested period.", "type": "string" }, "end_month": { "title": "End month of the requested period.", "type": "integer" }, "end_year": { "title": "End year of the requested period.", "type": "integer" }, "duration": { "title": "duration in days linked to NonWorkTimePlan - a half day type counts 0.5 (Z6)", "type": "number", "format": "float" }, "status": { "title": "Status of the request.", "type": "string" }, "content_type": { "title": "Type of the request, e.g. vacation or absence.", "type": "string" }, "secondary_content_type": { "title": "Secondary type of the request.", "type": "string" }, "linked_content_type": { "title": "Plan selection type linked to the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType3" } ] }, "parent_request": { "title": "The request this one changes (\"\u00c4nderungsantrag zum Jahresurlaub\"). A change request\nis an ordinary request in every other respect; the reference is what turns a second,\nunrelated looking request into a visible correction of the first - and what lets the\ndays it withdraws be marked as withdrawn instead of merely refused.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeRequest5" } ] }, "annual_request": { "title": "L47\/L48: the annual plan (\"Jahresurlaubsantrag\") this period belongs to. The bundle\nis decided as a whole; the period stays an ordinary request in every other respect.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest8" } ] }, "request_kind": { "title": "U02\/U18: ANNUAL = period of the annual plan, SUPPLEMENT = Erg\u00e4nzungsantrag for the\nheld back flexible days. null = ordinary request.", "type": "string" }, "processing_due_date": { "title": "U04\/U20: the day by which the request has to be decided, counted from its receipt.", "type": "string", "format": "date-time" }, "escalated_at": { "title": "U04: when the overdue escalation was sent; null = not (yet) escalated.", "type": "string", "format": "date-time" }, "written_approval_reason": { "title": "U21: why the management step with a written comment was added to this request\n(e.g. SUMMER_CANCELLATION); null = no extra written approval needed.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeRequest6": { "properties": { "overdue": { "title": "U04: still waiting after the processing deadline.", "type": "boolean" }, "approval_version": { "title": "Version of the approval process.", "type": "integer" }, "change_mode": { "title": "Mode of a change to the request.", "type": "string" }, "balance_override_reason": { "title": "L11: why a planner approved this request although the projected vacation balance was negative.", "type": "string" }, "coverage_override_reason": { "title": "L54: why the approver accepted a day below the minimum staffing.", "type": "string" }, "coverage_hint": { "title": "L53: handed in although it eats into the staffing buffer - the approvers see the hint.", "type": "boolean" }, "sick_during_vacation": { "title": "U13: a sick report inside approved vacation - set by the server, shown as \"w\u00e4hrend Urlaub\".", "type": "boolean" }, "consultation_note": { "title": "Who was consulted before requesting days a blocking period marks as consultation-only (U14).", "type": "string" }, "daily_absence_start_time": { "title": "Local daily absence window for half-day types; null preserves legacy planning.", "type": "string" }, "daily_absence_end_time": { "title": "End time of daily absence.", "type": "string" }, "id": { "title": "Primary key of the request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "contract": { "title": "Employment contract the request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract11" } ] }, "description": { "title": "Description of the request.", "type": "string" }, "start": { "title": "Start of the requested period.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the requested period.", "type": "string" }, "start_month": { "title": "Start month of the requested period.", "type": "integer" }, "start_year": { "title": "Start year of the requested period.", "type": "integer" }, "end": { "title": "End of the requested period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End date of the requested period.", "type": "string" }, "end_month": { "title": "End month of the requested period.", "type": "integer" }, "end_year": { "title": "End year of the requested period.", "type": "integer" }, "duration": { "title": "duration in days linked to NonWorkTimePlan - a half day type counts 0.5 (Z6)", "type": "number", "format": "float" }, "status": { "title": "Status of the request.", "type": "string" }, "content_type": { "title": "Type of the request, e.g. vacation or absence.", "type": "string" }, "secondary_content_type": { "title": "Secondary type of the request.", "type": "string" }, "linked_content_type": { "title": "Plan selection type linked to the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType3" } ] }, "attachments": { "title": "Attachments of the request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "comments": { "title": "Comments on the request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimeRequestComment5" } }, "plan_entries": { "title": "Plan entries generated for the request.", "type": "array", "items": { "$ref": "#\/components\/schemas\/NonWorkTimePlan2" } }, "parent_request": { "title": "The request this one changes (\"\u00c4nderungsantrag zum Jahresurlaub\"). A change request\nis an ordinary request in every other respect; the reference is what turns a second,\nunrelated looking request into a visible correction of the first - and what lets the\ndays it withdraws be marked as withdrawn instead of merely refused.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeRequest6" } ] }, "annual_request": { "title": "L47\/L48: the annual plan (\"Jahresurlaubsantrag\") this period belongs to. The bundle\nis decided as a whole; the period stays an ordinary request in every other respect.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest3" } ] }, "request_kind": { "title": "U02\/U18: ANNUAL = period of the annual plan, SUPPLEMENT = Erg\u00e4nzungsantrag for the\nheld back flexible days. null = ordinary request.", "type": "string" }, "processing_due_date": { "title": "U04\/U20: the day by which the request has to be decided, counted from its receipt.", "type": "string", "format": "date-time" }, "escalated_at": { "title": "U04: when the overdue escalation was sent; null = not (yet) escalated.", "type": "string", "format": "date-time" }, "written_approval_reason": { "title": "U21: why the management step with a written comment was added to this request\n(e.g. SUMMER_CANCELLATION); null = no extra written approval needed.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeRequest7": { "properties": { "overdue": { "title": "U04: still waiting after the processing deadline.", "type": "boolean" }, "approval_version": { "title": "Version of the approval process.", "type": "integer" }, "change_mode": { "title": "Mode of a change to the request.", "type": "string" }, "balance_override_reason": { "title": "L11: why a planner approved this request although the projected vacation balance was negative.", "type": "string" }, "coverage_override_reason": { "title": "L54: why the approver accepted a day below the minimum staffing.", "type": "string" }, "coverage_hint": { "title": "L53: handed in although it eats into the staffing buffer - the approvers see the hint.", "type": "boolean" }, "sick_during_vacation": { "title": "U13: a sick report inside approved vacation - set by the server, shown as \"w\u00e4hrend Urlaub\".", "type": "boolean" }, "consultation_note": { "title": "Who was consulted before requesting days a blocking period marks as consultation-only (U14).", "type": "string" }, "daily_absence_start_time": { "title": "Local daily absence window for half-day types; null preserves legacy planning.", "type": "string" }, "daily_absence_end_time": { "title": "End time of daily absence.", "type": "string" }, "id": { "title": "Primary key of the request.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the request belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Description of the request.", "type": "string" }, "start": { "title": "Start of the requested period.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the requested period.", "type": "string" }, "start_month": { "title": "Start month of the requested period.", "type": "integer" }, "start_year": { "title": "Start year of the requested period.", "type": "integer" }, "end": { "title": "End of the requested period.", "type": "string", "format": "date-time" }, "end_date": { "title": "End date of the requested period.", "type": "string" }, "end_month": { "title": "End month of the requested period.", "type": "integer" }, "end_year": { "title": "End year of the requested period.", "type": "integer" }, "duration": { "title": "duration in days linked to NonWorkTimePlan - a half day type counts 0.5 (Z6)", "type": "number", "format": "float" }, "status": { "title": "Status of the request.", "type": "string" }, "content_type": { "title": "Type of the request, e.g. vacation or absence.", "type": "string" }, "secondary_content_type": { "title": "Secondary type of the request.", "type": "string" }, "linked_content_type": { "title": "Plan selection type linked to the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimePlanSelectionType3" } ] }, "parent_request": { "title": "The request this one changes (\"\u00c4nderungsantrag zum Jahresurlaub\"). A change request\nis an ordinary request in every other respect; the reference is what turns a second,\nunrelated looking request into a visible correction of the first - and what lets the\ndays it withdraws be marked as withdrawn instead of merely refused.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeRequest7" } ] }, "annual_request": { "title": "L47\/L48: the annual plan (\"Jahresurlaubsantrag\") this period belongs to. The bundle\nis decided as a whole; the period stays an ordinary request in every other respect.", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeAnnualRequest9" } ] }, "request_kind": { "title": "U02\/U18: ANNUAL = period of the annual plan, SUPPLEMENT = Erg\u00e4nzungsantrag for the\nheld back flexible days. null = ordinary request.", "type": "string" }, "processing_due_date": { "title": "U04\/U20: the day by which the request has to be decided, counted from its receipt.", "type": "string", "format": "date-time" }, "escalated_at": { "title": "U04: when the overdue escalation was sent; null = not (yet) escalated.", "type": "string", "format": "date-time" }, "written_approval_reason": { "title": "U21: why the management step with a written comment was added to this request\n(e.g. SUMMER_CANCELLATION); null = no extra written approval needed.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeRequestComment": { "properties": { "id": { "title": "Primary key of the absence request comment.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user who wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "contract": { "title": "Contract the comment is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract12" } ] }, "description": { "title": "Text of the comment.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeRequestComment2": { "properties": { "person": { "title": "Person who wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson40" } ] }, "contract": { "title": "Contract the comment is about.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract13" } ] }, "description": { "title": "Text of the comment.", "type": "string" } }, "type": "object" }, "NonWorkTimeRequestComment3": { "type": "object" }, "NonWorkTimeRequestComment4": { "properties": { "id": { "title": "Primary key of the absence request comment.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user who wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Text of the comment.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "NonWorkTimeRequestComment5": { "properties": { "id": { "title": "Primary key of the absence request comment.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user who wrote the comment.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Text of the comment.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "OauthServerClient": { "properties": { "identifier": { "title": "Identifier of the OAuth client.", "type": "string" }, "name": { "title": "Name of the OAuth client.", "type": "string" }, "scopes": { "title": "Comma-separated list of scopes the client may request.", "type": "string" }, "redirect_uri": { "title": "Allowed redirect URI.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "OauthServerClient2": { "properties": { "name": { "title": "Name of the OAuth client.", "type": "string" }, "scopes": { "title": "Comma-separated list of scopes the client may request.", "type": "string" }, "redirect_uri": { "title": "Allowed redirect URI.", "type": "string" }, "active": { "title": "Whether the client is active.", "type": "boolean" }, "allow_plain_text_pkce": { "title": "Whether PKCE with the plain challenge method is allowed.", "type": "boolean" }, "confidential": { "title": "Whether the client is confidential, i.e. it can keep its secret.", "type": "boolean" } }, "type": "object" }, "OauthServerClientPermission": { "properties": { "id": { "title": "Primary key of the client permission.", "description": "Internal ID.", "type": "integer" }, "scopes": { "title": "Comma-separated list of granted scopes.", "type": "string" }, "active": { "title": "Whether the permission is active.", "type": "boolean" }, "is_dg": { "title": "Whether the permission applies to the DG (member organization) context.", "type": "boolean" }, "selected_customer": { "title": "Customer profile the permission is limited to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomerProfile" } ] }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "OauthServerClientPermission2": { "properties": { "scopes": { "title": "Comma-separated list of granted scopes.", "type": "string" }, "active": { "title": "Whether the permission is active.", "type": "boolean" } }, "type": "object" }, "Offer": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject5" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice12" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] } }, "type": "object" }, "Offer10": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "mit_last_send_email": { "title": "Point in time the last e-mail was sent.", "type": "string", "format": "date-time" }, "mit_to_email": { "title": "E-mail address the mail is intended for.", "type": "string" }, "mit_should_send_email": { "title": "Whether an e-mail should be sent.", "type": "boolean" }, "mit_last_send_postal": { "title": "Point in time the last letter was sent.", "type": "string", "format": "date-time" }, "mit_to_address_name": { "title": "Name of the postal recipient.", "type": "string" }, "mit_to_address_street_level": { "title": "Street and house number of the postal recipient.", "type": "string" }, "mit_to_address_city": { "title": "City of the postal recipient.", "type": "string" }, "mit_to_address_zip": { "title": "Postal code of the postal recipient.", "type": "string" }, "mit_to_address_country": { "title": "Country of the postal recipient.", "type": "string" }, "mit_should_send_postal": { "title": "Whether a letter should be sent.", "type": "boolean" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem9" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer9" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject18" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice4" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "base_booking": { "title": "Booking the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking14" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup2" } ] } }, "type": "object" }, "Offer11": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem10" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer10" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject19" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice5" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "base_booking": { "title": "Booking the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking12" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup2" } ] } }, "type": "object" }, "Offer12": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem11" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer11" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject20" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice6" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "base_booking": { "title": "Booking the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking12" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup2" } ] } }, "type": "object" }, "Offer13": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "mit_last_send_email": { "title": "Point in time the last e-mail was sent.", "type": "string", "format": "date-time" }, "mit_to_email": { "title": "E-mail address the mail is intended for.", "type": "string" }, "mit_should_send_email": { "title": "Whether an e-mail should be sent.", "type": "boolean" }, "mit_last_send_postal": { "title": "Point in time the last letter was sent.", "type": "string", "format": "date-time" }, "mit_to_address_name": { "title": "Name of the postal recipient.", "type": "string" }, "mit_to_address_street_level": { "title": "Street and house number of the postal recipient.", "type": "string" }, "mit_to_address_city": { "title": "City of the postal recipient.", "type": "string" }, "mit_to_address_zip": { "title": "Postal code of the postal recipient.", "type": "string" }, "mit_to_address_country": { "title": "Country of the postal recipient.", "type": "string" }, "mit_should_send_postal": { "title": "Whether a letter should be sent.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem12" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer12" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject21" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice7" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "base_booking": { "title": "Booking the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking12" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup2" } ] } }, "type": "object" }, "Offer14": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem13" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer13" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject2" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice32" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] } }, "type": "object" }, "Offer15": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem14" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer14" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject8" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice33" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] } }, "type": "object" }, "Offer16": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem15" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer15" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject9" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice34" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] } }, "type": "object" }, "Offer17": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem16" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer16" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject10" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice35" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] } }, "type": "object" }, "Offer18": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem17" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer17" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject23" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice14" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] }, "base_booking": { "title": "Booking the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup3" } ] } }, "type": "object" }, "Offer19": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem18" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer18" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject22" } ] } }, "type": "object" }, "Offer2": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem2" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer2" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject" } ] } }, "type": "object" }, "Offer3": { "required": [ "offer_accounting_type" ], "properties": { "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem3" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer3" } ] } }, "type": "object" }, "Offer4": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "mit_last_send_email": { "title": "Point in time the last e-mail was sent.", "type": "string", "format": "date-time" }, "mit_to_email": { "title": "E-mail address the mail is intended for.", "type": "string" }, "mit_should_send_email": { "title": "Whether an e-mail should be sent.", "type": "boolean" }, "mit_last_send_postal": { "title": "Point in time the last letter was sent.", "type": "string", "format": "date-time" }, "mit_to_address_name": { "title": "Name of the postal recipient.", "type": "string" }, "mit_to_address_street_level": { "title": "Street and house number of the postal recipient.", "type": "string" }, "mit_to_address_city": { "title": "City of the postal recipient.", "type": "string" }, "mit_to_address_zip": { "title": "Postal code of the postal recipient.", "type": "string" }, "mit_to_address_country": { "title": "Country of the postal recipient.", "type": "string" }, "mit_should_send_postal": { "title": "Whether a letter should be sent.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem4" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer4" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject11" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice15" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] } }, "type": "object" }, "Offer5": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem5" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer5" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject13" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice21" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] } }, "type": "object" }, "Offer6": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem6" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer6" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject3" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice10" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp23" } ] } }, "type": "object" }, "Offer7": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem7" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer7" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject4" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice11" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp23" } ] } }, "type": "object" }, "Offer9": { "required": [ "tax", "offer_accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer_accounting_type": { "title": "Accounting type of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferAccountingType" } ] }, "items": { "title": "Items of the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OfferItem8" } }, "buyer": { "title": "Buyer of the offer.", "oneOf": [ { "$ref": "#\/components\/schemas\/OfferBuyer8" } ] }, "accepted_date": { "title": "Date the offer was accepted.", "type": "string", "format": "date-time" }, "is_accepted_date_from_ext_service": { "title": "The acceptance date comes from an external service.", "type": "boolean" }, "project": { "title": "Project the offer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject17" } ] }, "invoices": { "title": "Invoices created from the offer.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice3" } }, "base_event_sign_up": { "title": "Sign-up the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp11" } ] }, "base_booking": { "title": "Booking the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking12" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the offer was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup2" } ] } }, "type": "object" }, "OfferAccountingType": { "required": [ "name", "type" ], "properties": { "id": { "title": "Primary key of the offer accounting type.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the accounting type.", "type": "string" }, "cancelled_name": { "title": "Name used when an offer of this type is canceled.", "type": "string" }, "type": { "title": "Type of the accounting type, for example offer or contract.", "type": "string" }, "conditions": { "title": "Conditions printed on the offer.", "type": "string" }, "number_description": { "title": "Description of the number format of the offer.", "type": "string" }, "deleted": { "title": "The accounting type is deleted.", "type": "boolean" } }, "type": "object" }, "OfferBuyer": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer" } ] } }, "type": "object" }, "OfferBuyer10": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer11" } ] } }, "type": "object" }, "OfferBuyer11": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer12" } ] } }, "type": "object" }, "OfferBuyer12": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer13" } ] } }, "type": "object" }, "OfferBuyer13": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer14" } ] } }, "type": "object" }, "OfferBuyer14": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer15" } ] } }, "type": "object" }, "OfferBuyer15": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer16" } ] } }, "type": "object" }, "OfferBuyer16": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer17" } ] } }, "type": "object" }, "OfferBuyer17": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer18" } ] } }, "type": "object" }, "OfferBuyer18": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer19" } ] } }, "type": "object" }, "OfferBuyer2": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer2" } ] } }, "type": "object" }, "OfferBuyer3": { "properties": { "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "OfferBuyer4": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer4" } ] } }, "type": "object" }, "OfferBuyer5": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer5" } ] } }, "type": "object" }, "OfferBuyer6": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer6" } ] } }, "type": "object" }, "OfferBuyer7": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer7" } ] } }, "type": "object" }, "OfferBuyer8": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer9" } ] } }, "type": "object" }, "OfferBuyer9": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "offer": { "title": "Offer the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer10" } ] } }, "type": "object" }, "OfferItem": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem" } ] } }, "type": "object" }, "OfferItem10": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer11" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem9" } ] } }, "type": "object" }, "OfferItem11": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer12" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem10" } ] } }, "type": "object" }, "OfferItem12": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer13" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem11" } ] } }, "type": "object" }, "OfferItem13": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer14" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem12" } ] } }, "type": "object" }, "OfferItem14": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer15" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem13" } ] } }, "type": "object" }, "OfferItem15": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer16" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem14" } ] } }, "type": "object" }, "OfferItem16": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer17" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem15" } ] } }, "type": "object" }, "OfferItem17": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer18" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem16" } ] } }, "type": "object" }, "OfferItem18": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer19" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem17" } ] } }, "type": "object" }, "OfferItem2": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer2" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem2" } ] } }, "type": "object" }, "OfferItem3": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "booking": { "title": "Booking the invoice item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking24" } ] } }, "type": "object" }, "OfferItem4": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer4" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem3" } ] } }, "type": "object" }, "OfferItem5": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer5" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem4" } ] } }, "type": "object" }, "OfferItem6": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer6" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem5" } ] } }, "type": "object" }, "OfferItem7": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer7" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem6" } ] } }, "type": "object" }, "OfferItem8": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer9" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem7" } ] } }, "type": "object" }, "OfferItem9": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "offer": { "title": "Offer the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/Offer10" } ] }, "custom_product": { "title": "Customized product used for the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomizedBillingItem8" } ] } }, "type": "object" }, "OpenDataRedirect": { "properties": {}, "type": "object" }, "OrganizationUnit": { "properties": { "path": { "title": "The path label for pickers and lists: \"Gesch\u00e4ftsstelle \/ Bereich Sport \/ Halle Nord\".", "type": "string" }, "depth": { "type": "integer" }, "id": { "title": "Primary key of the organization unit.", "description": "Internal ID.", "type": "integer" }, "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "parent": { "title": "Parent organization of the unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit" } ] }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationUnit10": { "properties": { "path": { "title": "The path label for pickers and lists: \"Gesch\u00e4ftsstelle \/ Bereich Sport \/ Halle Nord\".", "type": "string" }, "depth": { "type": "integer" }, "id": { "title": "Primary key of the organization unit.", "description": "Internal ID.", "type": "integer" }, "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "parent": { "title": "Parent organization of the unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit10" } ] }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationUnit11": { "properties": { "path": { "title": "The path label for pickers and lists: \"Gesch\u00e4ftsstelle \/ Bereich Sport \/ Halle Nord\".", "type": "string" }, "depth": { "type": "integer" }, "id": { "title": "Primary key of the organization unit.", "description": "Internal ID.", "type": "integer" }, "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "parent": { "title": "Parent organization of the unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit11" } ] }, "leadership": { "title": "Leaders of this node; they lead everything below it.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "staffing_alarm_recipients": { "title": "R7: who is alerted when a staffing rule in this area falls below its minimum; empty =\nthe next area above, in the end staffing_alarm_recipient_persons.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationUnit2": { "properties": { "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "leadership": { "title": "Leaders of this node; they lead everything below it.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson26" } }, "staffing_alarm_recipients": { "title": "R7: who is alerted when a staffing rule in this area falls below its minimum; empty =\nthe next area above, in the end staffing_alarm_recipient_persons.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson26" } }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "OrganizationUnit3": { "properties": { "path": { "title": "The path label for pickers and lists: \"Gesch\u00e4ftsstelle \/ Bereich Sport \/ Halle Nord\".", "type": "string" }, "depth": { "type": "integer" }, "id": { "title": "Primary key of the organization unit.", "description": "Internal ID.", "type": "integer" }, "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "parent": { "title": "Parent organization of the unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit6" } ] }, "leadership": { "title": "Leaders of this node; they lead everything below it.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson27" } }, "staffing_alarm_recipients": { "title": "R7: who is alerted when a staffing rule in this area falls below its minimum; empty =\nthe next area above, in the end staffing_alarm_recipient_persons.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationUnit4": { "properties": { "path": { "title": "The path label for pickers and lists: \"Gesch\u00e4ftsstelle \/ Bereich Sport \/ Halle Nord\".", "type": "string" }, "depth": { "type": "integer" }, "id": { "title": "Primary key of the organization unit.", "description": "Internal ID.", "type": "integer" }, "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "parent": { "title": "Parent organization of the unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit4" } ] }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationUnit5": { "properties": { "path": { "title": "The path label for pickers and lists: \"Gesch\u00e4ftsstelle \/ Bereich Sport \/ Halle Nord\".", "type": "string" }, "depth": { "type": "integer" }, "id": { "title": "Primary key of the organization unit.", "description": "Internal ID.", "type": "integer" }, "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "parent": { "title": "Parent organization of the unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit5" } ] }, "leadership": { "title": "Leaders of this node; they lead everything below it.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "staffing_alarm_recipients": { "title": "R7: who is alerted when a staffing rule in this area falls below its minimum; empty =\nthe next area above, in the end staffing_alarm_recipient_persons.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationUnit6": { "properties": { "path": { "title": "The path label for pickers and lists: \"Gesch\u00e4ftsstelle \/ Bereich Sport \/ Halle Nord\".", "type": "string" }, "depth": { "type": "integer" }, "id": { "title": "Primary key of the organization unit.", "description": "Internal ID.", "type": "integer" }, "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "parent": { "title": "Parent organization of the unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit6" } ] }, "leadership": { "title": "Leaders of this node; they lead everything below it.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "staffing_alarm_recipients": { "title": "R7: who is alerted when a staffing rule in this area falls below its minimum; empty =\nthe next area above, in the end staffing_alarm_recipient_persons.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationUnit7": { "properties": { "path": { "title": "The path label for pickers and lists: \"Gesch\u00e4ftsstelle \/ Bereich Sport \/ Halle Nord\".", "type": "string" }, "depth": { "type": "integer" }, "id": { "title": "Primary key of the organization unit.", "description": "Internal ID.", "type": "integer" }, "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "parent": { "title": "Parent organization of the unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit7" } ] }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationUnit8": { "properties": { "path": { "title": "The path label for pickers and lists: \"Gesch\u00e4ftsstelle \/ Bereich Sport \/ Halle Nord\".", "type": "string" }, "depth": { "type": "integer" }, "id": { "title": "Primary key of the organization unit.", "description": "Internal ID.", "type": "integer" }, "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "parent": { "title": "Parent organization of the unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit8" } ] }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationUnit9": { "properties": { "path": { "title": "The path label for pickers and lists: \"Gesch\u00e4ftsstelle \/ Bereich Sport \/ Halle Nord\".", "type": "string" }, "depth": { "type": "integer" }, "id": { "title": "Primary key of the organization unit.", "description": "Internal ID.", "type": "integer" }, "level": { "title": "The tier this node stands for, free text (Gesch\u00e4ftsstelle, Bereich, Einrichtung, ...).", "type": "string" }, "parent": { "title": "Parent organization of the unit.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit9" } ] }, "leadership": { "title": "Leaders of this node; they lead everything below it.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "staffing_alarm_recipients": { "title": "R7: who is alerted when a staffing rule in this area falls below its minimum; empty =\nthe next area above, in the end staffing_alarm_recipient_persons.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMPerson10" } }, "sort_order": { "title": "Order among siblings.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "PaymentGoal": { "properties": { "id": { "title": "Primary key of the payment goal.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the payment term, for example 14 days.", "type": "string" }, "date_string": { "title": "Date pattern of the payment term as text.", "type": "string" }, "deleted": { "title": "The payment term is deleted.", "type": "boolean" }, "global_default": { "title": "Default payment term for new invoices.", "type": "boolean" } }, "type": "object" }, "PaymentTransaction": { "properties": { "auto": { "title": "The transaction was created automatically.", "type": "boolean" }, "incoming": { "title": "The transaction is incoming money.", "type": "boolean" }, "bank_transaction": { "title": "The transaction comes from a bank account.", "type": "boolean" }, "currency": { "title": "Currency of the transaction, for example EUR.", "type": "string" }, "payment_type": { "title": "Payment type of the transaction.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "invoices": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice18" } }, "brutto_value": { "title": "Gross amount of the transaction.", "type": "number", "format": "float" }, "is_fee": { "title": "The transaction is a fee, for example a bank fee.", "type": "boolean" }, "due_date": { "title": "This is used for negative transactions to exclude them from potential bill reminders until they are due.", "type": "string", "format": "date-time" }, "cash_discount": { "title": "Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch\nZahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist z\u00e4hlen\nihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im\nZeitraum des Abzugs (\u00a7 17 Abs. 1 UStG).", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "PaymentTransaction2": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany" }, "auto": { "title": "The transaction was created automatically.", "type": "boolean" }, "incoming": { "title": "The transaction is incoming money.", "type": "boolean" }, "bank_transaction": { "title": "The transaction comes from a bank account.", "type": "boolean" }, "currency": { "title": "Currency of the transaction, for example EUR.", "type": "string" }, "payment_type": { "title": "Payment type of the transaction.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "invoices": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice19" } }, "incoming_invoices": { "title": "Verkn\u00fcpfte Eingangsrechnungen", "type": "array", "items": { "$ref": "#\/components\/schemas\/IncomingInvoice2" } }, "product": { "title": "Product the transaction pays for.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem10" } ] }, "brutto_value": { "title": "Gross amount of the transaction.", "type": "number", "format": "float" }, "unified_category": { "title": "Category the transaction belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory17" } ] }, "person": { "title": "Person the transaction belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "is_fee": { "title": "The transaction is a fee, for example a bank fee.", "type": "boolean" }, "due_date": { "title": "This is used for negative transactions to exclude them from potential bill reminders until they are due.", "type": "string", "format": "date-time" }, "cash_discount": { "title": "Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch\nZahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist z\u00e4hlen\nihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im\nZeitraum des Abzugs (\u00a7 17 Abs. 1 UStG).", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "PaymentTransaction3": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "auto": { "title": "The transaction was created automatically.", "type": "boolean" }, "incoming": { "title": "The transaction is incoming money.", "type": "boolean" }, "bank_transaction": { "title": "The transaction comes from a bank account.", "type": "boolean" }, "currency": { "title": "Currency of the transaction, for example EUR.", "type": "string" }, "payment_type": { "title": "Payment type of the transaction.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "invoices": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice20" } }, "brutto_value": { "title": "Gross amount of the transaction.", "type": "number", "format": "float" }, "unified_category": { "title": "Category the transaction belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory37" } ] }, "person": { "title": "Person the transaction belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "is_fee": { "title": "The transaction is a fee, for example a bank fee.", "type": "boolean" }, "due_date": { "title": "This is used for negative transactions to exclude them from potential bill reminders until they are due.", "type": "string", "format": "date-time" }, "cash_discount": { "title": "Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch\nZahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist z\u00e4hlen\nihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im\nZeitraum des Abzugs (\u00a7 17 Abs. 1 UStG).", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "PaymentTransaction4": { "properties": { "auto": { "title": "The transaction was created automatically.", "type": "boolean" }, "incoming": { "title": "The transaction is incoming money.", "type": "boolean" }, "bank_transaction": { "title": "The transaction comes from a bank account.", "type": "boolean" }, "currency": { "title": "Currency of the transaction, for example EUR.", "type": "string" }, "payment_type": { "title": "Payment type of the transaction.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "invoices": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice31" } }, "brutto_value": { "title": "Gross amount of the transaction.", "type": "number", "format": "float" }, "is_fee": { "title": "The transaction is a fee, for example a bank fee.", "type": "boolean" }, "due_date": { "title": "This is used for negative transactions to exclude them from potential bill reminders until they are due.", "type": "string", "format": "date-time" }, "cash_discount": { "title": "Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch\nZahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist z\u00e4hlen\nihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im\nZeitraum des Abzugs (\u00a7 17 Abs. 1 UStG).", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "PaymentType": { "properties": { "id": { "title": "Primary key of the payment type.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the payment type, for example transfer or cash.", "type": "string" }, "auto": { "title": "Payments of this type are matched automatically.", "type": "boolean" }, "conditions": { "title": "Conditions for matching payments to this type.", "type": "string" }, "linked_keywords": { "title": "Keywords in bank transactions that link to this payment type.", "type": "string" }, "global_default": { "title": "Default payment type for new invoices.", "type": "boolean" }, "bank_import_default": { "title": "Default payment type for bank imports.", "type": "boolean" }, "is_direct_debit": { "title": "The payment type is a direct debit.", "type": "boolean" }, "is_external": { "title": "The payment is handled by an external service.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "PaymentType6": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "PerformanceConfig": { "properties": { "id": { "title": "Primary key of the performance configuration.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "Whether the performance optimizations are active.", "type": "boolean" }, "caching": { "title": "Whether page caching is enabled.", "type": "boolean" }, "memcached": { "title": "Whether Memcached is used for caching.", "type": "boolean" }, "compression": { "title": "Whether responses are compressed.", "type": "boolean" }, "asyncjs": { "title": "Whether JavaScript is loaded asynchronously.", "type": "boolean" }, "asyncexclusions": { "title": "Scripts excluded from asynchronous loading.", "type": "string" }, "optimize_images": { "title": "Whether images are optimized.", "type": "boolean" }, "webp": { "title": "Whether images are served as WebP.", "type": "boolean" }, "disable_emoji": { "title": "Whether the emoji script is disabled.", "type": "boolean" }, "disable_block_editor_css": { "title": "Whether the block editor CSS is disabled.", "type": "boolean" }, "disable_jquery_migrate": { "title": "Whether jQuery Migrate is disabled.", "type": "boolean" }, "asset_push": { "title": "Whether assets are pushed to the client early.", "type": "boolean" }, "preconnect_urls": { "title": "URLs to preconnect to.", "type": "string" } }, "type": "object" }, "PersonLogBookEntry": { "properties": { "id": { "title": "Primary key of the log book entry.", "description": "Internal ID.", "type": "integer" }, "content": { "title": "Content of the entry.", "type": "string" }, "content_type": { "title": "Type of the entry.", "type": "string" }, "content_type_addition": { "title": "Additional detail of the entry type.", "type": "string" }, "start": { "title": "Start of the entry.", "type": "string", "format": "date-time" }, "start_billing": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the entry.", "type": "string", "format": "date-time" }, "expiry_warning_sent_at": { "title": "Set when an expiry warning was sent; cleared when the end date changes so the warning\nre-arms (see BookableComponentExpiryCheckCommand)", "type": "string", "format": "date-time" }, "discount_start": { "title": "Start of the discount period.", "type": "string", "format": "date-time" }, "discount_end": { "title": "End of the discount period.", "type": "string", "format": "date-time" }, "free_start": { "title": "Start of the free period.", "type": "string", "format": "date-time" }, "free_end": { "title": "End of the free period.", "type": "string", "format": "date-time" }, "passive_start": { "title": "Start of the passive period.", "type": "string", "format": "date-time" }, "passive_end": { "title": "End of the passive period.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" } }, "type": "object" }, "PersonLogBookEntry10": { "properties": { "id": { "title": "Primary key of the log book entry.", "description": "Internal ID.", "type": "integer" }, "content": { "title": "Content of the entry.", "type": "string" }, "content_type": { "title": "Type of the entry.", "type": "string" }, "content_type_addition": { "title": "Additional detail of the entry type.", "type": "string" }, "start": { "title": "Start of the entry.", "type": "string", "format": "date-time" }, "start_billing": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the entry.", "type": "string", "format": "date-time" }, "expiry_warning_sent_at": { "title": "Set when an expiry warning was sent; cleared when the end date changes so the warning\nre-arms (see BookableComponentExpiryCheckCommand)", "type": "string", "format": "date-time" }, "discount_start": { "title": "Start of the discount period.", "type": "string", "format": "date-time" }, "discount_end": { "title": "End of the discount period.", "type": "string", "format": "date-time" }, "free_start": { "title": "Start of the free period.", "type": "string", "format": "date-time" }, "free_end": { "title": "End of the free period.", "type": "string", "format": "date-time" }, "passive_start": { "title": "Start of the passive period.", "type": "string", "format": "date-time" }, "passive_end": { "title": "End of the passive period.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" } }, "type": "object" }, "PersonLogBookEntry2": { "properties": { "id": { "title": "Primary key of the log book entry.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "company": { "title": "Company the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "content": { "title": "Content of the entry.", "type": "string" }, "content_type": { "title": "Type of the entry.", "type": "string" }, "content_type_addition": { "title": "Additional detail of the entry type.", "type": "string" }, "start": { "title": "Start of the entry.", "type": "string", "format": "date-time" }, "start_billing": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the entry.", "type": "string", "format": "date-time" }, "expiry_warning_sent_at": { "title": "Set when an expiry warning was sent; cleared when the end date changes so the warning\nre-arms (see BookableComponentExpiryCheckCommand)", "type": "string", "format": "date-time" }, "product": { "title": "Billing item booked with the entry.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem9" } ] }, "unified_category": { "title": "Unified category of the entry.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory10" } ] }, "discount_start": { "title": "Start of the discount period.", "type": "string", "format": "date-time" }, "discount_end": { "title": "End of the discount period.", "type": "string", "format": "date-time" }, "discount_product": { "title": "Billing item used for the discount.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem9" } ] }, "free_start": { "title": "Start of the free period.", "type": "string", "format": "date-time" }, "free_end": { "title": "End of the free period.", "type": "string", "format": "date-time" }, "free_product": { "title": "Billing item used for the free period.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem9" } ] }, "passive_start": { "title": "Start of the passive period.", "type": "string", "format": "date-time" }, "passive_end": { "title": "End of the passive period.", "type": "string", "format": "date-time" }, "passive_product": { "title": "Billing item used for the passive period.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem9" } ] }, "invoices": { "title": "Invoices the entry is billed on.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Invoice9" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" } }, "type": "object" }, "PersonLogBookEntry6": { "properties": { "id": { "title": "Primary key of the log book entry.", "description": "Internal ID.", "type": "integer" }, "content": { "title": "Content of the entry.", "type": "string" }, "content_type": { "title": "Type of the entry.", "type": "string" }, "content_type_addition": { "title": "Additional detail of the entry type.", "type": "string" }, "start": { "title": "Start of the entry.", "type": "string", "format": "date-time" }, "start_billing": { "title": "Start of the billed period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the entry.", "type": "string", "format": "date-time" }, "expiry_warning_sent_at": { "title": "Set when an expiry warning was sent; cleared when the end date changes so the warning\nre-arms (see BookableComponentExpiryCheckCommand)", "type": "string", "format": "date-time" }, "discount_start": { "title": "Start of the discount period.", "type": "string", "format": "date-time" }, "discount_end": { "title": "End of the discount period.", "type": "string", "format": "date-time" }, "free_start": { "title": "Start of the free period.", "type": "string", "format": "date-time" }, "free_end": { "title": "End of the free period.", "type": "string", "format": "date-time" }, "passive_start": { "title": "Start of the passive period.", "type": "string", "format": "date-time" }, "passive_end": { "title": "End of the passive period.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" } }, "type": "object" }, "PiwikConfig": { "properties": { "id": { "title": "Primary key of the Piwik configuration.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "Whether Piwik tracking is active.", "type": "boolean" }, "tracking_token": { "title": "Tracking token of the Piwik site.", "type": "string" }, "serverurl": { "title": "URL of the Piwik server.", "type": "string" } }, "type": "object" }, "PredefinedBillingItem": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable3" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable3" }, "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent7" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany21" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "start_template": { "title": "Template used for the start of the item in documents.", "oneOf": [ { "$ref": "#\/components\/schemas\/FlexibleLatexTemplate" } ] }, "end_template": { "title": "Template used for the end of the item in documents.", "oneOf": [ { "$ref": "#\/components\/schemas\/FlexibleLatexTemplate" } ] }, "event_data_type": { "title": "Event data type the item applies to.", "type": "string" }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType3" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation3" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_scope_event": { "title": "Scope: budget limited to specific event", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent7" } ] }, "budget_scope_category": { "title": "Scope: budget limited to events of this category", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory16" } ] }, "budget_scope_event_type": { "title": "Scope: budget limited to events of this type (WORKSHOP, CAMP, etc.)", "type": "string" }, "budget_validity_days": { "title": "Duration in days the budget is valid after purchase (null = no expiry)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory16" } }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem10": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem10" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType16" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem11": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem11" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType17" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem12": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" } }, "type": "object" }, "PredefinedBillingItem13": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem13" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType18" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem14": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany47" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem14" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType19" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation22" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory27" } }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem15": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem15" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType20" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem16": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem16" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType21" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem17": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany50" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem17" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType22" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation25" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem18": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem18" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType23" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem19": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem19" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType24" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem2": { "required": [ "name", "description" ], "properties": { "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType4" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment12" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment12" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment12" } ] }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory11" } }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "accounting_software_number": { "title": "Number of the entity in the accounting software.", "type": "string" } }, "type": "object" }, "PredefinedBillingItem20": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem20" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType25" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem21": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem21" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType26" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem22": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany23" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem22" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType27" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem23": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem23" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType28" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem24": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "baseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "secondaryBaseBookable": { "$ref": "#\/components\/schemas\/BaseBookable10" }, "baseEvent": { "$ref": "#\/components\/schemas\/BaseEvent14" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem24" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType29" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem25": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany3" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem25" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType30" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation32" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory12" } }, "atags": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessTag" } }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem26": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany4" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem26" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType31" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation33" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory13" } }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem27": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem27" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType32" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem28": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem28" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType33" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem29": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany19" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem29" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType34" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "atags": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessTag" } }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem3": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany40" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem3" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType11" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation15" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory4" } }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem30": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem30" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType35" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem4": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType6" } ] }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "ucats": { "title": "Unified categories of the entity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory5" } }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem5": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem5" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType12" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem6": { "type": "object" }, "PredefinedBillingItem7": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem7" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType13" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem8": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem8" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType14" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "PredefinedBillingItem9": { "required": [ "name", "description" ], "properties": { "id": { "title": "Primary key of the mapped billing item.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the billing item.", "type": "string" }, "description": { "title": "Description of the billing item shown to the customer.", "type": "string" }, "internal_description": { "title": "Internal description of the billing item, not shown to the customer.", "type": "string" }, "fixed_hours": { "title": "Fixed number of hours billed.", "type": "number", "format": "float" }, "fixed_price": { "title": "Fixed price billed.", "type": "number", "format": "float" }, "fixed_price_base_unit": { "title": "Base unit for the fixed price.", "type": "number", "format": "float" }, "price_fixed_hours": { "title": "Price for the fixed hours.", "type": "number", "format": "float" }, "price_additional_hours": { "title": "Price for each additional hour.", "type": "number", "format": "float" }, "name_additional_hours": { "title": "Name of the additional hours item.", "type": "string" }, "description_additional_hours": { "title": "Description of the additional hours item.", "type": "string" }, "time_billed_on_ticket_close": { "title": "Whether the time is billed when the ticket is closed.", "type": "boolean" }, "billing_type": { "title": "Billing item type.", "oneOf": [ { "$ref": "#\/components\/schemas\/BillingItemType" } ] }, "buying_price": { "title": "Purchase price of the item.", "type": "number", "format": "float" }, "recurrence": { "title": "Recurrence the billing item follows.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMRecurrence" } ] }, "deleted": { "title": "Whether the billing item is deleted.", "type": "boolean" }, "condition_date_after": { "title": "The item applies only to dates after this date.", "type": "string", "format": "date-time" }, "condition_date_before": { "title": "The item applies only to dates before this date.", "type": "string", "format": "date-time" }, "condition_country_code": { "title": "Country code the item applies to.", "type": "string" }, "condition_zip_code_from": { "title": "Start of the postal code range the item applies to.", "type": "string" }, "condition_zip_code_to": { "title": "End of the postal code range the item applies to.", "type": "string" }, "condition_time_after_hour": { "title": "The item applies only after this hour of the day.", "type": "integer" }, "condition_max_length": { "title": "Maximum length the item applies to.", "type": "integer" }, "condition_time_before_hour": { "title": "The item applies only before this hour of the day.", "type": "integer" }, "condition_sub_access_tag": { "title": "Access tag a subscription must have for the item to apply.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccessTag" } ] }, "condition_show_despite_missing_access_tag": { "title": "Whether the item is shown even if the access tag is missing.", "type": "boolean" }, "condition_sub_free_logic": { "title": "Free-form condition logic for the subscription.", "type": "string" }, "fixed_price_logic": { "title": "Free-form logic that calculates the fixed price.", "type": "string" }, "sub_self_service_add": { "title": "Whether members can add the subscription themselves.", "type": "boolean" }, "sub_self_service_delete": { "title": "Whether members can cancel the subscription themselves.", "type": "boolean" }, "sub_self_service_add_fixed_price": { "title": "Fixed price charged when members add the subscription themselves.", "type": "number", "format": "float" }, "sub_self_service_delete_fixed_price": { "title": "Fixed price charged when members cancel the subscription themselves.", "type": "number", "format": "float" }, "sub_pre_paid": { "title": "Whether the subscription is paid in advance.", "type": "boolean" }, "sub_only_billed_after_start": { "title": "Whether the subscription is only billed after its start date.", "type": "boolean" }, "sub_people_age_group_one": { "title": "Upper age limit of age group one.", "type": "integer" }, "sub_people_age_group_one_discount": { "title": "Discount in percent for age group one.", "type": "integer" }, "sub_people_age_group_one_free": { "title": "Number of free places for age group one.", "type": "integer" }, "sub_people_age_group_two": { "title": "Upper age limit of age group two.", "type": "integer" }, "sub_people_age_group_two_discount": { "title": "Discount in percent for age group two.", "type": "integer" }, "sub_people_age_group_two_free": { "title": "Number of free places for age group two.", "type": "integer" }, "sub_people_age_group_three": { "title": "Upper age limit of age group three.", "type": "integer" }, "sub_people_age_group_three_discount": { "title": "Discount in percent for age group three.", "type": "integer" }, "sub_people_age_group_three_free": { "title": "Number of free places for age group three.", "type": "integer" }, "sub_people_age_group_four": { "title": "Upper age limit of age group four.", "type": "integer" }, "sub_people_age_group_four_discount": { "title": "Discount in percent for age group four.", "type": "integer" }, "sub_people_age_group_four_free": { "title": "Number of free places for age group four.", "type": "integer" }, "price_is_brutto": { "title": "Whether the prices are gross prices including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "company": { "title": "Company the billing item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "parent": { "title": "Parent billing item, for example for variants.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem9" } ] }, "is_preferred": { "title": "The item is preferred and shown first.", "type": "boolean" }, "is_default": { "title": "The item is the default for its type.", "type": "boolean" }, "is_discount": { "title": "The item is a discount.", "type": "boolean" }, "is_free": { "title": "The item is free of charge.", "type": "boolean" }, "is_passive": { "title": "The item is passive and cannot be selected anymore.", "type": "boolean" }, "is_global": { "title": "The item is available for all companies.", "type": "boolean" }, "inventory_count": { "title": "Number of pieces in stock, if the item is a product.", "type": "integer" }, "stock_item": { "title": "This is flag for items that can be ordered at any time", "type": "boolean" }, "producer_guarantee_years": { "title": "Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears).\nGrundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).\nProducer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.", "type": "number", "format": "float" }, "producer_brand": { "title": "Hersteller \/ Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld \"Brand\/Trademark\"\ndes EU GARAN Labels. Producer \/ brand offering the commercial guarantee of durability.", "type": "string" }, "energy_label_attachment": { "title": "Energielabel (EU Energieverbrauchskennzeichnung) als Bild\/PDF fuer Shop, Warenkorb und Mail.\nEU energy label image\/PDF of this product.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_attachment": { "title": "Grosses EU GARAN Label (DVO 2025\/1960): kostenlose Haltbarkeitsgarantie des Herstellers\nvon mehr als zwei Jahren, mit Jahren, Marke und Modell.\nFull EU GARAN label (commercial guarantee of durability > 2 years).", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "garan_label_pictogram_attachment": { "title": "\"Nested label\" \/ Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick\/Hover\nmuss das grosse Label (garanLabelAttachment) erscheinen.\nEU GARAN \"nested label\" pictogram showing only the years; links to the full label online.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "public_category": { "title": "Category of the item shown publicly.", "type": "string" }, "condition_booking_content_type": { "title": "Item applies only to bookings with this content type (e.g. flight type). Null = all content types.", "oneOf": [ { "$ref": "#\/components\/schemas\/BookingContentType15" } ] }, "usage_time_base": { "title": "Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or\nBILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.", "type": "integer" }, "base_location": { "title": "Location this charge belongs to (e.g. airport landing\/takeoff fee), category CATEGORY_LOCATION", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseLocation10" } ] }, "condition_day_of_week_mask": { "title": "Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.", "type": "integer" }, "condition_first_usage_only": { "title": "Charge applies only once per usage record (first matching section, quantity 1)", "type": "boolean" }, "budget_grant_count": { "title": "Number of event sign-ups this product grants when purchased (null = no budget)", "type": "integer" }, "budget_create_once": { "title": "If true, budget is only created once per person+product combination.\nFor recurring subscriptions: monthly payment but yearly budget.", "type": "boolean" }, "ticket_quota": { "title": "Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis).", "description": "Null = nur das Teilnehmerlimit des Events z\u00e4hlt.", "type": "integer" }, "ticket_sale_start": { "title": "Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Fr\u00fchbucher ab), null = sofort.", "type": "string", "format": "date-time" }, "ticket_sale_end": { "title": "Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Fr\u00fchbucher bis), null = bis zum Anmeldeschluss.", "type": "string", "format": "date-time" }, "ticket_seat_zone": { "title": "Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur f\u00fcr Pl\u00e4tze dieser Preiszone\n(BaseLocationPlanItem::seatZone), null = f\u00fcr jeden Platz.", "type": "string" }, "cancellation_term_unit": { "title": "Allowed cancellation terms for this subscription product. Null \/ empty = inherit the club\ndefault from settings. See CancellationTermCalculator::TERM_UNITS.", "type": "string" }, "cancellation_term_dates": { "title": "Comma separated list of fixed cancellation dates in DD.MM format, e.g. \"31.03,30.06,30.09,31.12\".\nOnly used when cancellationTermUnit is CUSTOM.", "type": "string" }, "cancellation_notice_value": { "title": "Numeric value of the notice period before the cancellation term. Null = inherit from settings.", "type": "integer" }, "cancellation_notice_unit": { "title": "Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.", "type": "string" }, "external_access_mode": { "title": "Access granted by an external purchase, independently of billing recurrence or event budgets.", "type": "string", "enum": [ "none", "purchase", "rental" ] }, "external_access_duration_days": { "title": "Days the external access for the item is valid.", "type": "integer", "maximum": 36500, "minimum": 1 }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "ProcessedEmploymentContractMonth": { "properties": { "id": { "title": "Primary key of the processed month.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "User the processed month belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "contract": { "title": "Employment contract the processed month belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract6" } ] }, "start_month": { "title": "Month the processed period starts.", "type": "integer" }, "start_year": { "title": "Year the processed period starts.", "type": "integer" }, "start_wts": { "title": "calculated seconds from last month as start balance", "type": "integer" }, "overtime_last_year_wts": { "title": "calculated overtime seconds from last year as start balance", "type": "integer" }, "end_wts": { "title": "calculated result of worked seconds for this month", "type": "integer" }, "correction_wts": { "title": "manual correction for worked seconds for this month", "type": "integer" }, "real_wts": { "title": "real worked seconds for this month", "type": "integer" }, "planned_wts": { "title": "planned worked seconds for this month", "type": "integer" }, "live_end_wts": { "title": "calculated result of worked seconds for this month until today", "type": "integer" }, "live_real_wts": { "title": "real worked seconds for this month until today", "type": "integer" }, "live_planned_wts": { "title": "planned worked seconds for this month until today", "type": "integer" }, "live_wts_status": { "title": "status of the live wts", "type": "string" }, "start_vd": { "title": "calculated vacation days from last month as start balance", "type": "number", "format": "float" }, "unconfirmed_start_vd": { "title": "calculated vacation days from last month as start balance that are unconfirmed", "type": "number", "format": "float" }, "start_sum_vd": { "title": "calculated vacation days for year until last month", "type": "number", "format": "float" }, "start_last_year_vd": { "title": "calculated open vacation days from last year as start balance", "type": "number", "format": "float" }, "end_last_year_vd": { "title": "calculated open vacation days from last year as end balance", "type": "number", "format": "float" }, "correction_last_year_vd": { "title": "manual correction for vacation days from last year", "type": "number", "format": "float" }, "real_last_year_vd": { "title": "real used vacation days for this month from last year", "type": "number", "format": "float" }, "start_real_last_year_vd": { "title": "real used vacation days summed up until start of current month", "type": "number", "format": "float" }, "end_real_last_year_vd": { "title": "real used vacation days summed up until end of current month", "type": "number", "format": "float" }, "expired_last_year_vd": { "title": "calculated expired vacation days from last year", "type": "number", "format": "float" }, "start_expired_last_year_vd": { "title": "sum of expired vacation days at start of month", "type": "number", "format": "float" }, "end_expired_last_year_vd": { "title": "sum of expired vacation days at end of month", "type": "number", "format": "float" }, "end_vd": { "title": "calculated result of vacation days for this month", "type": "number", "format": "float" }, "unconfirmed_end_vd": { "title": "calculated result of vacation days for this month that are unconfirmed", "type": "number", "format": "float" }, "end_sum_vd": { "title": "calculated result of vacation days for year until this month", "type": "number", "format": "float" }, "new_vd": { "title": "new vacation days for this month from contract", "type": "number", "format": "float" }, "correction_vd": { "title": "manual correction for vacation days for this month", "type": "number", "format": "float" }, "real_vd": { "title": "real used vacation days for this month", "type": "number", "format": "float" }, "unconfirmed_real_vd": { "title": "real used vacation days for this month that are unconfirmed", "type": "number", "format": "float" }, "real_wd": { "title": "real work days for this month", "type": "number", "format": "float" }, "start_sd": { "title": "calculated sick days from last month as start balance", "type": "number", "format": "float" }, "unconfirmed_start_sd": { "title": "calculated sick days from last month as start balance that are unconfirmed", "type": "number", "format": "float" }, "end_sd": { "title": "calculated result of sick days for this month", "type": "number", "format": "float" }, "unconfirmed_end_sd": { "title": "calculated result of sick days for this month that are unconfirmed", "type": "number", "format": "float" }, "correction_sd": { "title": "manual correction for sick days for this month", "type": "number", "format": "float" }, "real_sd": { "title": "real sick days for this month", "type": "number", "format": "float" }, "unconfirmed_real_sd": { "title": "real sick days for this month that are unconfirmed", "type": "number", "format": "float" }, "start_csd": { "title": "calculated child sick days (Kind krank, \u00a7 45 SGB V) of the year up to last month as start balance", "type": "number", "format": "float" }, "unconfirmed_start_csd": { "title": "calculated child sick days from last month as start balance that are unconfirmed", "type": "number", "format": "float" }, "end_csd": { "title": "calculated child sick days of the year up to this month", "type": "number", "format": "float" }, "unconfirmed_end_csd": { "title": "calculated child sick days of the year up to this month that are unconfirmed", "type": "number", "format": "float" }, "correction_csd": { "title": "manual correction for child sick days for this month", "type": "number", "format": "float" }, "real_csd": { "title": "real child sick days for this month - counted apart from the own sick days", "type": "number", "format": "float" }, "unconfirmed_real_csd": { "title": "real child sick days for this month that are unconfirmed", "type": "number", "format": "float" }, "dirty": { "title": "mark for recalculation", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ProcessedEmploymentContractMonth2": { "properties": { "correction_wts": { "title": "manual correction for worked seconds for this month", "type": "integer" }, "correction_last_year_vd": { "title": "manual correction for vacation days from last year", "type": "number", "format": "float" }, "correction_vd": { "title": "manual correction for vacation days for this month", "type": "number", "format": "float" }, "correction_sd": { "title": "manual correction for sick days for this month", "type": "number", "format": "float" }, "correction_csd": { "title": "manual correction for child sick days for this month", "type": "number", "format": "float" } }, "type": "object" }, "ProformaInvoice": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the proforma invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the proforma invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the proforma invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Proformarechnung (Einnahmen-Zuordnung)\nWird beim Anlegen der echten Rechnung \u00fcbernommen, damit die Sph\u00e4re an\nder Veranstaltung h\u00e4ngt und nicht am Zahlweg", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "buyer": { "title": "Buyer of the proforma invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/ProformaInvoiceBuyer" } ] }, "payment_date": { "title": "Date the proforma invoice was paid.", "type": "string", "format": "date-time" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "cancel_date": { "title": "Date the proforma invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" } }, "type": "object" }, "ProformaInvoice2": { "required": [ "tax", "accounting_type" ], "properties": { "id": { "title": "Primary key of the invoice document.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the document for public access.", "type": "string" }, "number": { "title": "Running document number.", "type": "integer" }, "manual_number_prefix": { "title": "Prefix of a manually entered document number.", "type": "string" }, "manual_number": { "title": "Manually entered document number.", "type": "integer" }, "number_string": { "title": "Document number as displayed to users.", "type": "string" }, "generation_date": { "title": "Date the document was generated.", "type": "string", "format": "date-time" }, "number_date": { "title": "Date used for the document number.", "type": "string", "format": "date-time" }, "message": { "title": "Message printed on the document.", "type": "string" }, "currency": { "title": "Currency of the document.", "type": "string" }, "name": { "title": "Name of the document.", "type": "string" }, "due_date": { "title": "Due date of the document.", "type": "string", "format": "date-time" }, "netto_value": { "title": "Net total of the document.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross total of the document.", "type": "number", "format": "float" }, "tax_value": { "title": "Total tax amount of the document.", "type": "number", "format": "float" }, "tax": { "title": "Tax rate applied to the document.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "linked_number_title": { "title": "Title of the linked document number.", "type": "string" }, "linked_number": { "title": "Number of the linked document.", "type": "string" }, "status": { "title": "Status of the document.", "type": "string" }, "previous_status": { "title": "Status before the last change.", "type": "string" }, "status_updated": { "title": "Point in time the status was last changed.", "type": "string", "format": "date-time" }, "archived": { "title": "Whether the document is archived.", "type": "boolean" }, "last_pdf_export": { "title": "Point in time the PDF was last exported.", "type": "string", "format": "date-time" }, "last_status_export": { "title": "Status at the last export.", "type": "string" }, "base_booking_group": { "title": "Booking group the document is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookingGroup10" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "accounting_type": { "title": "Accounting type of the proforma invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/AccountingType" } ] }, "payment_type": { "title": "Payment type of the proforma invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentType" } ] }, "payment_goal": { "title": "Payment term of the proforma invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/PaymentGoal" } ] }, "expense_category": { "title": "E\u00dcR-Kategorie f\u00fcr diese Proformarechnung (Einnahmen-Zuordnung)\nWird beim Anlegen der echten Rechnung \u00fcbernommen, damit die Sph\u00e4re an\nder Veranstaltung h\u00e4ngt und nicht am Zahlweg", "oneOf": [ { "$ref": "#\/components\/schemas\/ExpenseCategory10" } ] }, "items": { "title": "Items of the proforma invoice.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ProformaInvoiceItem" } }, "buyer": { "title": "Buyer of the proforma invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/ProformaInvoiceBuyer2" } ] }, "payment_date": { "title": "Date the proforma invoice was paid.", "type": "string", "format": "date-time" }, "is_payment_date_from_ext_service": { "title": "The payment date comes from an external service.", "type": "boolean" }, "payment_provider_status": { "title": "Status at the payment provider.", "type": "string" }, "payment_provider_reference": { "title": "Reference at the payment provider.", "type": "string" }, "payment_provider_transaction_reference": { "title": "Transaction reference at the payment provider.", "type": "string" }, "cancel_date": { "title": "Date the proforma invoice was canceled.", "type": "string", "format": "date-time" }, "cancel_text": { "title": "Text of the cancellation.", "type": "string" }, "base_event_sign_up": { "title": "Sign-up the proforma invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] }, "base_booking": { "title": "Booking the proforma invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "base_event_sign_up_group": { "title": "Sign-up group the proforma invoice was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUpGroup3" } ] }, "final_invoice": { "title": "Final invoice that replaced the proforma invoice.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice14" } ] }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "ProformaInvoiceBuyer": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Proforma invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ProformaInvoice" } ] } }, "type": "object" }, "ProformaInvoiceBuyer2": { "properties": { "id": { "title": "Primary key of the client.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the client on the invoice.", "type": "string" }, "vat_id": { "title": "VAT ID of the client.", "type": "string" }, "taxnumber": { "title": "Tax number of the client.", "type": "string" }, "buyer_reference_id": { "title": "Leitweg-ID or custom reference ID defined by the customer", "type": "string" }, "secondary_name": { "title": "Second name line of the client on the invoice.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "number": { "title": "Customer number of the buyer.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "invoice": { "title": "Proforma invoice the buyer belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ProformaInvoice2" } ] } }, "type": "object" }, "ProformaInvoiceItem": { "required": [ "quantity", "price", "name", "unit" ], "properties": { "id": { "title": "Primary key of the invoice item.", "description": "Internal ID.", "type": "integer" }, "description": { "title": "Description of the invoice item.", "type": "string" }, "price_is_brutto": { "title": "Whether the price is a gross price including tax.", "type": "boolean" }, "sku": { "title": "Artikelnummer (Stock Keeping Unit)", "type": "string" }, "barcode": { "title": "Barcode (ISBN, UPC, GTIN usw.)", "type": "string" }, "item_type": { "title": "Typ (Item, Shipping)", "type": "string" }, "netto_value": { "title": "Net value of the invoice item.", "type": "number", "format": "float" }, "brutto_value": { "title": "Gross value of the invoice item.", "type": "number", "format": "float" }, "tax_value": { "title": "Tax amount of the invoice item.", "type": "number", "format": "float" }, "quantity": { "title": "Quantity of the invoice item.", "type": "number", "format": "float" }, "price": { "title": "Unit price of the invoice item.", "type": "number", "format": "float" }, "name": { "title": "Name of the invoice item.", "type": "string" }, "unit": { "title": "Unit of the invoice item.", "type": "string" }, "tax": { "title": "Tax rate applied to the invoice item.", "oneOf": [ { "$ref": "#\/components\/schemas\/Tax" } ] }, "invoice": { "title": "Proforma invoice the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ProformaInvoice2" } ] }, "project_item": { "title": "Project item the item was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProjectItem9" } ] }, "base_event_sign_up": { "title": "Sign-up the item was created for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEventSignUp10" } ] }, "product": { "title": "Product of the item.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem16" } ] } }, "type": "object" }, "ProjectTimeReport": { "properties": { "id": { "title": "Primary key of the project time report.", "description": "Internal ID.", "type": "integer" }, "project": { "title": "Project the time report belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject6" } ] }, "invoice": { "title": "Invoice the time report was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice13" } ] }, "items": { "title": "Items of the time report.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ProjectTimeReportItem" } }, "time_billed_on_ticket_close": { "title": "Time is billed when the ticket is closed.", "type": "boolean" }, "start": { "title": "Start of the reported period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the reported period.", "type": "string", "format": "date-time" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" } }, "type": "object" }, "ProjectTimeReport2": { "properties": { "id": { "title": "Primary key of the project time report.", "description": "Internal ID.", "type": "integer" }, "project": { "title": "Project the time report belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject12" } ] }, "invoice": { "title": "Invoice the time report was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice16" } ] }, "items": { "title": "Items of the time report.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ProjectTimeReportItem2" } }, "time_billed_on_ticket_close": { "title": "Time is billed when the ticket is closed.", "type": "boolean" }, "start": { "title": "Start of the reported period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the reported period.", "type": "string", "format": "date-time" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" } }, "type": "object" }, "ProjectTimeReport3": { "properties": { "id": { "title": "Primary key of the project time report.", "description": "Internal ID.", "type": "integer" }, "project": { "title": "Project the time report belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject" } ] }, "invoice": { "title": "Invoice the time report was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice" } ] }, "time_billed_on_ticket_close": { "title": "Time is billed when the ticket is closed.", "type": "boolean" }, "start": { "title": "Start of the reported period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the reported period.", "type": "string", "format": "date-time" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" } }, "type": "object" }, "ProjectTimeReport4": { "properties": { "id": { "title": "Primary key of the project time report.", "description": "Internal ID.", "type": "integer" }, "project": { "title": "Project the time report belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject17" } ] }, "invoice": { "title": "Invoice the time report was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice3" } ] }, "time_billed_on_ticket_close": { "title": "Time is billed when the ticket is closed.", "type": "boolean" }, "start": { "title": "Start of the reported period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the reported period.", "type": "string", "format": "date-time" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" } }, "type": "object" }, "ProjectTimeReport5": { "properties": { "id": { "title": "Primary key of the project time report.", "description": "Internal ID.", "type": "integer" }, "project": { "title": "Project the time report belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject18" } ] }, "invoice": { "title": "Invoice the time report was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice4" } ] }, "time_billed_on_ticket_close": { "title": "Time is billed when the ticket is closed.", "type": "boolean" }, "start": { "title": "Start of the reported period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the reported period.", "type": "string", "format": "date-time" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" }, "mit_last_send_email": { "title": "Point in time the last e-mail was sent.", "type": "string", "format": "date-time" }, "mit_to_email": { "title": "E-mail address the mail is intended for.", "type": "string" }, "mit_should_send_email": { "title": "Whether an e-mail should be sent.", "type": "boolean" }, "mit_last_send_postal": { "title": "Point in time the last letter was sent.", "type": "string", "format": "date-time" }, "mit_to_address_name": { "title": "Name of the postal recipient.", "type": "string" }, "mit_to_address_street_level": { "title": "Street and house number of the postal recipient.", "type": "string" }, "mit_to_address_city": { "title": "City of the postal recipient.", "type": "string" }, "mit_to_address_zip": { "title": "Postal code of the postal recipient.", "type": "string" }, "mit_to_address_country": { "title": "Country of the postal recipient.", "type": "string" }, "mit_should_send_postal": { "title": "Whether a letter should be sent.", "type": "boolean" } }, "type": "object" }, "ProjectTimeReport6": { "properties": { "id": { "title": "Primary key of the project time report.", "description": "Internal ID.", "type": "integer" }, "project": { "title": "Project the time report belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject19" } ] }, "invoice": { "title": "Invoice the time report was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice5" } ] }, "time_billed_on_ticket_close": { "title": "Time is billed when the ticket is closed.", "type": "boolean" }, "start": { "title": "Start of the reported period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the reported period.", "type": "string", "format": "date-time" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" } }, "type": "object" }, "ProjectTimeReport7": { "properties": { "id": { "title": "Primary key of the project time report.", "description": "Internal ID.", "type": "integer" }, "project": { "title": "Project the time report belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject20" } ] }, "invoice": { "title": "Invoice the time report was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice6" } ] }, "time_billed_on_ticket_close": { "title": "Time is billed when the ticket is closed.", "type": "boolean" }, "start": { "title": "Start of the reported period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the reported period.", "type": "string", "format": "date-time" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" } }, "type": "object" }, "ProjectTimeReport8": { "properties": { "id": { "title": "Primary key of the project time report.", "description": "Internal ID.", "type": "integer" }, "project": { "title": "Project the time report belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject21" } ] }, "invoice": { "title": "Invoice the time report was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice7" } ] }, "time_billed_on_ticket_close": { "title": "Time is billed when the ticket is closed.", "type": "boolean" }, "start": { "title": "Start of the reported period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the reported period.", "type": "string", "format": "date-time" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" }, "mit_last_send_email": { "title": "Point in time the last e-mail was sent.", "type": "string", "format": "date-time" }, "mit_to_email": { "title": "E-mail address the mail is intended for.", "type": "string" }, "mit_should_send_email": { "title": "Whether an e-mail should be sent.", "type": "boolean" }, "mit_last_send_postal": { "title": "Point in time the last letter was sent.", "type": "string", "format": "date-time" }, "mit_to_address_name": { "title": "Name of the postal recipient.", "type": "string" }, "mit_to_address_street_level": { "title": "Street and house number of the postal recipient.", "type": "string" }, "mit_to_address_city": { "title": "City of the postal recipient.", "type": "string" }, "mit_to_address_zip": { "title": "Postal code of the postal recipient.", "type": "string" }, "mit_to_address_country": { "title": "Country of the postal recipient.", "type": "string" }, "mit_should_send_postal": { "title": "Whether a letter should be sent.", "type": "boolean" } }, "type": "object" }, "ProjectTimeReport9": { "properties": { "id": { "title": "Primary key of the project time report.", "description": "Internal ID.", "type": "integer" }, "project": { "title": "Project the time report belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject23" } ] }, "invoice": { "title": "Invoice the time report was billed on.", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice14" } ] }, "time_billed_on_ticket_close": { "title": "Time is billed when the ticket is closed.", "type": "boolean" }, "start": { "title": "Start of the reported period.", "type": "string", "format": "date-time" }, "end": { "title": "End of the reported period.", "type": "string", "format": "date-time" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" } }, "type": "object" }, "ProjectTimeReportItem": { "properties": { "id": { "title": "Primary key of the project time report item.", "description": "Internal ID.", "type": "integer" }, "ticket": { "title": "Ticket the item was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomerTicket5" } ] }, "project_time_report": { "title": "Project time report the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ProjectTimeReport" } ] }, "name": { "title": "Name of the ticket or task.", "type": "string" }, "status": { "title": "Status of the ticket or task.", "type": "string" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" } }, "type": "object" }, "ProjectTimeReportItem2": { "properties": { "id": { "title": "Primary key of the project time report item.", "description": "Internal ID.", "type": "integer" }, "ticket": { "title": "Ticket the item was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomerTicket5" } ] }, "project_time_report": { "title": "Project time report the item belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ProjectTimeReport2" } ] }, "name": { "title": "Name of the ticket or task.", "type": "string" }, "status": { "title": "Status of the ticket or task.", "type": "string" }, "time_string_billable": { "title": "Billable time as text.", "type": "string" }, "time_string_not_billable": { "title": "Non-billable time as text.", "type": "string" } }, "type": "object" }, "PublicSession": { "properties": { "token": { "title": "Token that identifies the public session.", "type": "string" }, "person_first_name": { "title": "First name of the person entered in the session.", "type": "string" }, "person_last_name": { "title": "Last name of the person entered in the session.", "type": "string" }, "person_email": { "title": "E-mail address of the person entered in the session.", "type": "string" }, "person_phone": { "title": "Phone number of the person entered in the session.", "type": "string" }, "company_name": { "title": "Name of the company entered in the session.", "type": "string" }, "company_email": { "title": "E-mail address of the company entered in the session.", "type": "string" }, "company_phone": { "title": "Phone number of the company entered in the session.", "type": "string" }, "company_address": { "title": "Address of the company, as text.", "type": "string" }, "company_address_street_level": { "title": "Street and house number of the company address.", "type": "string" }, "company_address_co": { "title": "Care-of line of the company address.", "type": "string" }, "company_address_city": { "title": "City of the company address.", "type": "string" }, "company_address_zip": { "title": "Postal code of the company address.", "type": "string" }, "company_address_country": { "title": "Country of the company address.", "type": "string" }, "person_address": { "title": "Address of the person, as text.", "type": "string" }, "person_address_street_level": { "title": "Street and house number of the person address.", "type": "string" }, "person_address_co": { "title": "Care-of line of the person address.", "type": "string" }, "person_address_city": { "title": "City of the person address.", "type": "string" }, "person_address_zip": { "title": "Postal code of the person address.", "type": "string" }, "person_address_country": { "title": "Country of the person address.", "type": "string" }, "person_birthday": { "title": "Birthday of the person entered in the session.", "type": "string", "format": "date-time" }, "person_gender": { "title": "Gender of the person entered in the session.", "type": "string" } }, "type": "object" }, "PublicSession2": { "properties": { "person_first_name": { "title": "First name of the person entered in the session.", "type": "string" }, "person_last_name": { "title": "Last name of the person entered in the session.", "type": "string" }, "person_email": { "title": "E-mail address of the person entered in the session.", "type": "string" }, "person_phone": { "title": "Phone number of the person entered in the session.", "type": "string" }, "company_name": { "title": "Name of the company entered in the session.", "type": "string" }, "company_email": { "title": "E-mail address of the company entered in the session.", "type": "string" }, "company_phone": { "title": "Phone number of the company entered in the session.", "type": "string" }, "company_address": { "title": "Address of the company, as text.", "type": "string" }, "company_address_street_level": { "title": "Street and house number of the company address.", "type": "string" }, "company_address_co": { "title": "Care-of line of the company address.", "type": "string" }, "company_address_city": { "title": "City of the company address.", "type": "string" }, "company_address_zip": { "title": "Postal code of the company address.", "type": "string" }, "company_address_country": { "title": "Country of the company address.", "type": "string" }, "person_address": { "title": "Address of the person, as text.", "type": "string" }, "person_address_street_level": { "title": "Street and house number of the person address.", "type": "string" }, "person_address_co": { "title": "Care-of line of the person address.", "type": "string" }, "person_address_city": { "title": "City of the person address.", "type": "string" }, "person_address_zip": { "title": "Postal code of the person address.", "type": "string" }, "person_address_country": { "title": "Country of the person address.", "type": "string" }, "person_birthday": { "title": "Birthday of the person entered in the session.", "type": "string", "format": "date-time" }, "person_gender": { "title": "Gender of the person entered in the session.", "type": "string" } }, "type": "object" }, "PublicSession3": { "properties": { "id": { "title": "Primary key of the public session.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the public session.", "type": "string" }, "person_first_name": { "title": "First name of the person entered in the session.", "type": "string" }, "person_last_name": { "title": "Last name of the person entered in the session.", "type": "string" }, "person_email": { "title": "E-mail address of the person entered in the session.", "type": "string" }, "person_phone": { "title": "Phone number of the person entered in the session.", "type": "string" }, "company_name": { "title": "Name of the company entered in the session.", "type": "string" }, "company_email": { "title": "E-mail address of the company entered in the session.", "type": "string" }, "company_phone": { "title": "Phone number of the company entered in the session.", "type": "string" }, "company_address": { "title": "Address of the company, as text.", "type": "string" }, "company_address_street_level": { "title": "Street and house number of the company address.", "type": "string" }, "company_address_co": { "title": "Care-of line of the company address.", "type": "string" }, "company_address_city": { "title": "City of the company address.", "type": "string" }, "company_address_zip": { "title": "Postal code of the company address.", "type": "string" }, "company_address_country": { "title": "Country of the company address.", "type": "string" }, "person_address": { "title": "Address of the person, as text.", "type": "string" }, "person_address_street_level": { "title": "Street and house number of the person address.", "type": "string" }, "person_address_co": { "title": "Care-of line of the person address.", "type": "string" }, "person_address_city": { "title": "City of the person address.", "type": "string" }, "person_address_zip": { "title": "Postal code of the person address.", "type": "string" }, "person_address_country": { "title": "Country of the person address.", "type": "string" }, "person_birthday": { "title": "Birthday of the person entered in the session.", "type": "string", "format": "date-time" }, "person_gender": { "title": "Gender of the person entered in the session.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "PublicSession4": { "properties": { "id": { "title": "Primary key of the public session.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the public session.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "RegisteredWebhook": { "properties": { "reference_class_name": { "title": "Class name of the records the webhook refers to.", "type": "string" }, "reference_ids": { "title": "IDs of the records the webhook refers to.", "type": "string" }, "database_action": { "title": "Database action that triggers the webhook.", "type": "string" }, "notification_type": { "title": "Type of the notification sent by the webhook.", "type": "string" }, "notification_url": { "title": "URL the webhook sends its request to.", "type": "string" }, "request_timeout": { "title": "Timeout of the webhook request in seconds.", "type": "integer" }, "notification_value_path": { "title": "Path of the value sent in the webhook request.", "type": "string" }, "include_write_permission": { "title": "Whether the write permission is included in the request.", "type": "boolean" }, "debug_mode_until": { "title": "Point in time the debug mode switches itself off at. Null means debug\nmode was never used; a value in the past means the window has expired.", "description": "There is no separate \"enabled\" flag on purpose \u2014 a timestamp cannot be\nleft switched on by a client that crashes before it can switch it off.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "RegisteredWebhook2": { "properties": { "reference_class_name": { "title": "Class name of the records the webhook refers to.", "type": "string" }, "reference_ids": { "title": "IDs of the records the webhook refers to.", "type": "string" }, "database_action": { "title": "Database action that triggers the webhook.", "type": "string" }, "notification_type": { "title": "Type of the notification sent by the webhook.", "type": "string" }, "notification_url": { "title": "URL the webhook sends its request to.", "type": "string" }, "notification_client_id": { "title": "Client ID sent with the webhook request.", "type": "string" }, "notification_client_token": { "title": "Client token sent with the webhook request.", "type": "string" }, "request_timeout": { "title": "Timeout of the webhook request in seconds.", "type": "integer" }, "notification_value_path": { "title": "Path of the value sent in the webhook request.", "type": "string" }, "include_write_permission": { "title": "Whether the write permission is included in the request.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "RegisteredWebhook3": { "properties": { "reference_class_name": { "title": "Class name of the records the webhook refers to.", "type": "string" }, "reference_ids": { "title": "IDs of the records the webhook refers to.", "type": "string" }, "database_action": { "title": "Database action that triggers the webhook.", "type": "string" }, "notification_type": { "title": "Type of the notification sent by the webhook.", "type": "string" }, "debug_mode_until": { "title": "Point in time the debug mode switches itself off at. Null means debug\nmode was never used; a value in the past means the window has expired.", "description": "There is no separate \"enabled\" flag on purpose \u2014 a timestamp cannot be\nleft switched on by a client that crashes before it can switch it off.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "SIPCall": { "properties": { "id": { "title": "Primary key of the communication item.", "description": "Internal ID.", "type": "integer" }, "com_type": { "title": "Type of the communication item.", "type": "string" }, "com_created": { "title": "Point in time the item was created.", "type": "string", "format": "date-time" }, "com_title": { "title": "Title of the communication item.", "type": "string" }, "com_search_string": { "title": "Searchable text of the communication item.", "type": "string" }, "com_done": { "title": "Whether the item is done.", "type": "boolean" }, "com_person_ext": { "title": "External person the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "com_department_ext": { "title": "External department the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMDepartment" } ] }, "com_company_ext": { "title": "External company the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "com_project_ext": { "title": "External project the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject14" } ] }, "com_person_int": { "title": "Internal person the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "com_department_int": { "title": "Internal department the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMDepartment" } ] }, "com_company_int": { "title": "Internal company the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "com_project_int": { "title": "Internal project the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject14" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "incoming": { "title": "Whether the call is incoming.", "type": "boolean" }, "sip_id": { "title": "ID of the call in the SIP system.", "type": "string" }, "number_in": { "title": "Phone number of the caller.", "type": "string" }, "number_answering": { "title": "Phone number that answered the call.", "type": "string" }, "number_out": { "title": "Phone number the call was made to.", "type": "string" }, "date_new": { "title": "Point in time the call was received.", "type": "string", "format": "date-time" }, "date_answer": { "title": "Point in time the call was answered.", "type": "string", "format": "date-time" }, "date_hangup": { "title": "Point in time the call ended.", "type": "string", "format": "date-time" }, "reason_hangup": { "title": "Reason the call ended.", "type": "string" }, "slack_id": { "title": "ID of the Slack message that announces the call.", "type": "string" }, "message": { "title": "Message of the call, e.g. the caller's message.", "type": "string" } }, "type": "object" }, "SIPCall2": { "properties": { "id": { "title": "Primary key of the communication item.", "description": "Internal ID.", "type": "integer" }, "com_type": { "title": "Type of the communication item.", "type": "string" }, "com_created": { "title": "Point in time the item was created.", "type": "string", "format": "date-time" }, "com_title": { "title": "Title of the communication item.", "type": "string" }, "com_search_string": { "title": "Searchable text of the communication item.", "type": "string" }, "com_done": { "title": "Whether the item is done.", "type": "boolean" }, "com_person_ext": { "title": "External person the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "com_department_ext": { "title": "External department the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMDepartment" } ] }, "com_company_ext": { "title": "External company the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "com_project_ext": { "title": "External project the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject15" } ] }, "com_person_int": { "title": "Internal person the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "com_department_int": { "title": "Internal department the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMDepartment" } ] }, "com_company_int": { "title": "Internal company the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "com_project_int": { "title": "Internal project the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject15" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "incoming": { "title": "Whether the call is incoming.", "type": "boolean" }, "sip_id": { "title": "ID of the call in the SIP system.", "type": "string" }, "number_in": { "title": "Phone number of the caller.", "type": "string" }, "crmperson_in": { "title": "Person of the caller.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "crmdepartment_in": { "title": "Department of the caller.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMDepartment" } ] }, "crmcompany_in": { "title": "Company of the caller.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "number_answering": { "title": "Phone number that answered the call.", "type": "string" }, "crmperson_answering": { "title": "Person who answered the call.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "crmdepartment_answering": { "title": "Department that answered the call.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMDepartment" } ] }, "crmcompany_answering": { "title": "Company that answered the call.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "number_out": { "title": "Phone number the call was made to.", "type": "string" }, "crmperson_out": { "title": "Person the call was made to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "crmdepartment_out": { "title": "Department the call was made to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMDepartment" } ] }, "crmcompany_out": { "title": "Company the call was made to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "date_new": { "title": "Point in time the call was received.", "type": "string", "format": "date-time" }, "date_answer": { "title": "Point in time the call was answered.", "type": "string", "format": "date-time" }, "date_hangup": { "title": "Point in time the call ended.", "type": "string", "format": "date-time" }, "reason_hangup": { "title": "Reason the call ended.", "type": "string" }, "slack_id": { "title": "ID of the Slack message that announces the call.", "type": "string" }, "message": { "title": "Message of the call, e.g. the caller's message.", "type": "string" } }, "type": "object" }, "SIPCall3": { "properties": { "id": { "title": "Primary key of the communication item.", "description": "Internal ID.", "type": "integer" }, "com_type": { "title": "Type of the communication item.", "type": "string" }, "com_created": { "title": "Point in time the item was created.", "type": "string", "format": "date-time" }, "com_title": { "title": "Title of the communication item.", "type": "string" }, "com_search_string": { "title": "Searchable text of the communication item.", "type": "string" }, "com_done": { "title": "Whether the item is done.", "type": "boolean" }, "com_person_ext": { "title": "External person the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "com_department_ext": { "title": "External department the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMDepartment" } ] }, "com_company_ext": { "title": "External company the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "com_project_ext": { "title": "External project the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject" } ] }, "com_person_int": { "title": "Internal person the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "com_department_int": { "title": "Internal department the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMDepartment" } ] }, "com_company_int": { "title": "Internal company the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "com_project_int": { "title": "Internal project the item refers to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "incoming": { "title": "Whether the call is incoming.", "type": "boolean" }, "sip_id": { "title": "ID of the call in the SIP system.", "type": "string" }, "number_in": { "title": "Phone number of the caller.", "type": "string" }, "number_answering": { "title": "Phone number that answered the call.", "type": "string" }, "number_out": { "title": "Phone number the call was made to.", "type": "string" }, "date_new": { "title": "Point in time the call was received.", "type": "string", "format": "date-time" }, "date_answer": { "title": "Point in time the call was answered.", "type": "string", "format": "date-time" }, "date_hangup": { "title": "Point in time the call ended.", "type": "string", "format": "date-time" }, "reason_hangup": { "title": "Reason the call ended.", "type": "string" }, "slack_id": { "title": "ID of the Slack message that announces the call.", "type": "string" }, "message": { "title": "Message of the call, e.g. the caller's message.", "type": "string" } }, "type": "object" }, "SchoolHolidayRegion": { "properties": { "id": { "title": "Primary key of the school holiday region.", "description": "Internal ID.", "type": "integer" }, "region_code": { "title": "Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.", "type": "string" }, "sort_order": { "title": "Order in pickers.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "SchoolHolidayRegion2": { "properties": { "region_code": { "title": "Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.", "type": "string" }, "sort_order": { "title": "Order in pickers.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "SecurityConfig": { "properties": { "id": { "title": "Primary key of the security configuration.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "Whether the security configuration is active.", "type": "boolean" }, "hideversion": { "title": "Whether the server version is hidden.", "type": "boolean" }, "hidereadme": { "title": "Whether the readme file is hidden.", "type": "boolean" }, "htaccessrules": { "title": "Additional .htaccess rules.", "type": "boolean" }, "contentsecuritypolicy": { "title": "Whether a Content Security Policy header is set.", "type": "boolean" }, "contentsecuritypolicytext": { "title": "Content of the Content Security Policy header.", "type": "string" }, "httpstricttransportsecurity": { "title": "Whether the HTTP Strict Transport Security header is set.", "type": "boolean" }, "xframeoptions": { "title": "Value of the X-Frame-Options header.", "type": "boolean" }, "xxssprotection": { "title": "Whether the X-XSS-Protection header is set.", "type": "boolean" }, "xcontenttypeoptions": { "title": "Whether the X-Content-Type-Options header is set.", "type": "boolean" }, "recaptchav3_enabled": { "title": "Whether reCAPTCHA v3 is enabled.", "type": "boolean" }, "recaptchav3_secret_token": { "title": "Secret key for reCAPTCHA v3.", "type": "string" }, "recaptchav3_web_token": { "title": "Site key for reCAPTCHA v3.", "type": "string" }, "recaptchav3_min_score": { "title": "Minimum score a request needs to pass reCAPTCHA v3.", "type": "number", "format": "float" } }, "type": "object" }, "SelfServiceDiscountReason": { "properties": { "id": { "title": "Primary key of the discount reason.", "description": "Internal ID.", "type": "integer" }, "require_attachment": { "title": "The application needs a proof (upload) for this reason", "type": "boolean" }, "attachment_label": { "title": "Label of the proof, e.g. \"Immatrikulationsbescheinigung\" - empty means \"Nachweis der Erm\u00e4\u00dfigung\"", "type": "string" }, "attachment_hint": { "title": "Hint shown below the proof upload", "type": "string" }, "proof_valid_until_end_of_year": { "title": "The proof is valid until the 31.12. of the year the application is sent in", "type": "boolean" }, "proof_valid_months": { "title": "The proof is valid for this many months from the application - null \/ 0 means no limit", "type": "integer" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "order": { "title": "Position of the entity in the order.", "type": "integer" }, "min_age": { "title": "The lowest age (in years) a person may have to use this entry - null means no lower limit", "type": "integer" }, "max_age": { "title": "The highest age (in years) a person may have to use this entry - null means no upper limit", "type": "integer" } }, "type": "object" }, "SelfServiceMembershipCategory": { "properties": { "id": { "title": "Primary key of the membership category.", "description": "Internal ID.", "type": "integer" }, "membership_step": { "title": "Membership step the category belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/SelfServiceMembershipStep3" } ] }, "items": { "title": "Membership items in the category.", "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem2" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "unified_category": { "$ref": "#\/components\/schemas\/UnifiedCategory5" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" }, "min_age": { "title": "The lowest age (in years) a person may have to use this entry - null means no lower limit", "type": "integer" }, "max_age": { "title": "The highest age (in years) a person may have to use this entry - null means no upper limit", "type": "integer" } }, "type": "object" }, "SelfServiceMembershipCategory2": { "properties": { "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "SelfServiceMembershipCategory3": { "properties": { "id": { "title": "Primary key of the membership category.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "unified_category": { "$ref": "#\/components\/schemas\/UnifiedCategory5" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" }, "min_age": { "title": "The lowest age (in years) a person may have to use this entry - null means no lower limit", "type": "integer" }, "max_age": { "title": "The highest age (in years) a person may have to use this entry - null means no upper limit", "type": "integer" } }, "type": "object" }, "SelfServiceMembershipItem": { "properties": { "id": { "title": "Primary key of the membership item.", "description": "Internal ID.", "type": "integer" }, "products": { "title": "Billing items of the membership item.", "type": "array", "items": { "$ref": "#\/components\/schemas\/PredefinedBillingItem4" } }, "categories": { "title": "Categories of the membership item.", "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfServiceMembershipCategory3" } }, "required_item": { "title": "Membership item that is required before this one.", "oneOf": [ { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem" } ] }, "disable_for_flat_list": { "title": "This property is used to skip this item in the flat list of items. e.g. used on the website plugin", "type": "boolean" }, "require_attachment": { "title": "This property is used to require \/ recommend an attachment upload. With the setting\niw_self_service_membership_proofs_enabled the membership application needs a proof for this item.", "type": "boolean" }, "attachment_label": { "title": "Label of the proof the application asks for, e.g. \"\u00c4rztliche Verordnung\" - empty means the item name", "type": "string" }, "attachment_hint": { "title": "Hint shown below the proof upload, e.g. which documents are accepted", "type": "string" }, "covered_items": { "title": "Items this item already includes (e.g. the studio covers yoga). With the setting\niw_self_service_membership_item_coverage_enabled they are hidden in the same application.", "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem" } }, "require_billing": { "title": "This property is used to require billing for this item", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "unified_category": { "$ref": "#\/components\/schemas\/UnifiedCategory5" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" }, "min_age": { "title": "The lowest age (in years) a person may have to use this entry - null means no lower limit", "type": "integer" }, "max_age": { "title": "The highest age (in years) a person may have to use this entry - null means no upper limit", "type": "integer" } }, "type": "object" }, "SelfServiceMembershipItem2": { "properties": { "id": { "title": "Primary key of the membership item.", "description": "Internal ID.", "type": "integer" }, "required_item": { "title": "Membership item that is required before this one.", "oneOf": [ { "$ref": "#\/components\/schemas\/SelfServiceMembershipItem2" } ] }, "require_attachment": { "title": "This property is used to require \/ recommend an attachment upload. With the setting\niw_self_service_membership_proofs_enabled the membership application needs a proof for this item.", "type": "boolean" }, "attachment_label": { "title": "Label of the proof the application asks for, e.g. \"\u00c4rztliche Verordnung\" - empty means the item name", "type": "string" }, "attachment_hint": { "title": "Hint shown below the proof upload, e.g. which documents are accepted", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "unified_category": { "$ref": "#\/components\/schemas\/UnifiedCategory5" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" }, "min_age": { "title": "The lowest age (in years) a person may have to use this entry - null means no lower limit", "type": "integer" }, "max_age": { "title": "The highest age (in years) a person may have to use this entry - null means no upper limit", "type": "integer" } }, "type": "object" }, "SelfServiceMembershipStep": { "properties": { "id": { "title": "Primary key of the step.", "description": "Internal ID.", "type": "integer" }, "item_selection_required": { "title": "Whether an item must be selected in this step.", "type": "boolean" }, "multi_selection_allowed": { "title": "Whether several items may be selected.", "type": "boolean" }, "only_if_no_memberships": { "title": "Whether the step is shown only without existing memberships.", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "SelfServiceMembershipStep2": { "properties": { "id": { "title": "Primary key of the step.", "description": "Internal ID.", "type": "integer" }, "item_selection_required": { "title": "Whether an item must be selected in this step.", "type": "boolean" }, "multi_selection_allowed": { "title": "Whether several items may be selected.", "type": "boolean" }, "only_if_no_memberships": { "title": "Whether the step is shown only without existing memberships.", "type": "boolean" }, "categories": { "title": "Categories offered in the step.", "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfServiceMembershipCategory2" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "SelfServiceMembershipStep3": { "properties": { "id": { "title": "Primary key of the step.", "description": "Internal ID.", "type": "integer" }, "item_selection_required": { "title": "Whether an item must be selected in this step.", "type": "boolean" }, "multi_selection_allowed": { "title": "Whether several items may be selected.", "type": "boolean" }, "only_if_no_memberships": { "title": "Whether the step is shown only without existing memberships.", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "SelfSignUpLog": { "properties": { "id": { "title": "Primary key of the sign-up log entry.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token that identifies the sign-up.", "type": "string" }, "public_session_token": { "title": "Token of the public session the sign-up was made in.", "type": "string" }, "invite_code": { "title": "Invite code used for the sign-up.", "oneOf": [ { "$ref": "#\/components\/schemas\/SelfSignUpLogInviteCode2" } ] }, "person_first_name": { "title": "First name entered in the sign-up.", "type": "string" }, "person_last_name": { "title": "Last name entered in the sign-up.", "type": "string" }, "person_email": { "title": "E-mail address entered in the sign-up.", "type": "string" }, "person_phone": { "title": "Phone number entered in the sign-up.", "type": "string" }, "company_name": { "title": "Company name entered in the sign-up.", "type": "string" }, "company_email": { "title": "Company e-mail address entered in the sign-up.", "type": "string" }, "company_phone": { "title": "Company phone number entered in the sign-up.", "type": "string" }, "company_address": { "title": "Address of the company, as text.", "type": "string" }, "company_address_street_level": { "title": "Street and house number of the company address.", "type": "string" }, "company_address_co": { "title": "Care-of line of the company address.", "type": "string" }, "company_address_city": { "title": "City of the company address.", "type": "string" }, "company_address_zip": { "title": "Postal code of the company address.", "type": "string" }, "company_address_country": { "title": "Country of the company address.", "type": "string" }, "person_address": { "title": "Address of the person, as text.", "type": "string" }, "person_address_street_level": { "title": "Street and house number of the person address.", "type": "string" }, "person_address_co": { "title": "Care-of line of the person address.", "type": "string" }, "person_address_city": { "title": "City of the person address.", "type": "string" }, "person_address_zip": { "title": "Postal code of the person address.", "type": "string" }, "person_address_country": { "title": "Country of the person address.", "type": "string" }, "person_birthday": { "title": "Birthday entered in the sign-up.", "type": "string", "format": "date-time" }, "person_gender": { "title": "Gender entered in the sign-up.", "type": "string" }, "person_grade_level": { "title": "Grade level entered in the sign-up.", "type": "integer" }, "person_school_class": { "title": "School class entered in the sign-up.", "type": "string" }, "person_category": { "title": "Person category entered in the sign-up.", "type": "string" }, "ticket_ticket_type": { "title": "Ticket type created by the sign-up.", "type": "string" }, "ticket_issuetype": { "title": "A type like bug, task, story", "type": "string" }, "ticket_issue_category": { "title": "A category like website, hosting, marketing", "type": "string" }, "require_sepa": { "title": "Whether a SEPA mandate is required.", "type": "boolean" }, "require_address": { "title": "Whether an address is required.", "type": "boolean" }, "require_company_name": { "title": "Whether a company name is required.", "type": "string" }, "require_person_address": { "title": "Whether a person address is required.", "type": "boolean" }, "require_person_birthday": { "title": "Whether a birthday is required.", "type": "boolean" }, "require_person_gender": { "title": "Whether a gender is required.", "type": "boolean" }, "require_person_phone": { "title": "Whether a phone number is required.", "type": "string" }, "require_ticket": { "title": "Whether a ticket is required.", "type": "boolean" }, "additional_people": { "title": "Additional people registered in the same sign-up.", "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfSignUpLogAdditionalPerson" } }, "processed_company_number": { "title": "Number of the company created from the sign-up.", "type": "string" }, "processed_company_id": { "title": "ID of the company created from the sign-up.", "type": "string" }, "processed_person_id": { "title": "ID of the person created from the sign-up.", "type": "string" }, "processed_user_id": { "title": "ID of the user created from the sign-up.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "SelfSignUpLog2": { "properties": { "person_first_name": { "title": "First name entered in the sign-up.", "type": "string" }, "person_last_name": { "title": "Last name entered in the sign-up.", "type": "string" }, "person_email": { "title": "E-mail address entered in the sign-up.", "type": "string" }, "person_phone": { "title": "Phone number entered in the sign-up.", "type": "string" }, "company_name": { "title": "Company name entered in the sign-up.", "type": "string" }, "company_email": { "title": "Company e-mail address entered in the sign-up.", "type": "string" }, "company_phone": { "title": "Company phone number entered in the sign-up.", "type": "string" }, "company_address": { "title": "Address of the company, as text.", "type": "string" }, "company_address_street_level": { "title": "Street and house number of the company address.", "type": "string" }, "company_address_co": { "title": "Care-of line of the company address.", "type": "string" }, "company_address_city": { "title": "City of the company address.", "type": "string" }, "company_address_zip": { "title": "Postal code of the company address.", "type": "string" }, "company_address_country": { "title": "Country of the company address.", "type": "string" }, "person_address": { "title": "Address of the person, as text.", "type": "string" }, "person_address_street_level": { "title": "Street and house number of the person address.", "type": "string" }, "person_address_co": { "title": "Care-of line of the person address.", "type": "string" }, "person_address_city": { "title": "City of the person address.", "type": "string" }, "person_address_zip": { "title": "Postal code of the person address.", "type": "string" }, "person_address_country": { "title": "Country of the person address.", "type": "string" }, "person_birthday": { "title": "Birthday entered in the sign-up.", "type": "string", "format": "date-time" }, "person_gender": { "title": "Gender entered in the sign-up.", "type": "string" }, "person_grade_level": { "title": "Grade level entered in the sign-up.", "type": "integer" }, "person_school_class": { "title": "School class entered in the sign-up.", "type": "string" }, "person_category": { "title": "Person category entered in the sign-up.", "type": "string" }, "ticket_ticket_type": { "title": "Ticket type created by the sign-up.", "type": "string" }, "ticket_issuetype": { "title": "A type like bug, task, story", "type": "string" }, "ticket_issue_category": { "title": "A category like website, hosting, marketing", "type": "string" }, "additional_people": { "title": "Additional people registered in the same sign-up.", "type": "array", "items": { "$ref": "#\/components\/schemas\/SelfSignUpLogAdditionalPerson2" } }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" } }, "type": "object" }, "SelfSignUpLogAdditionalPerson": { "properties": { "id": { "title": "Primary key of the additional person.", "description": "Internal ID.", "type": "integer" }, "person_first_name": { "title": "First name of the additional person.", "type": "string" }, "person_last_name": { "title": "Last name of the additional person.", "type": "string" }, "person_email": { "title": "E-mail address of the additional person.", "type": "string" }, "person_phone": { "title": "Phone number of the additional person.", "type": "string" }, "person_address": { "title": "Address of the additional person, as text.", "type": "string" }, "person_address_street_level": { "title": "Street and house number of the additional person's address.", "type": "string" }, "person_address_co": { "title": "Care-of line of the additional person's address.", "type": "string" }, "person_address_city": { "title": "City of the additional person's address.", "type": "string" }, "person_address_zip": { "title": "Postal code of the additional person's address.", "type": "string" }, "person_address_country": { "title": "Country of the additional person's address.", "type": "string" }, "person_birthday": { "title": "Birthday of the additional person.", "type": "string", "format": "date-time" }, "person_gender": { "title": "Gender of the additional person.", "type": "string" }, "person_grade_level": { "title": "Grade level of the additional person.", "type": "integer" }, "person_school_class": { "title": "School class of the additional person.", "type": "string" }, "person_category": { "title": "Category of the additional person.", "type": "string" }, "ticket_ticket_type": { "title": "Ticket type for the additional person's ticket.", "type": "string" }, "ticket_issuetype": { "title": "Issue type for the additional person's ticket.", "type": "string" }, "ticket_issue_category": { "title": "Issue category for the additional person's ticket.", "type": "string" }, "ticket_headline": { "title": "Headline of the additional person's ticket.", "type": "string" }, "ticket_description": { "title": "Description of the additional person's ticket.", "type": "string" }, "processed_person_id": { "title": "ID of the person created for the additional person.", "type": "string" } }, "type": "object" }, "SelfSignUpLogAdditionalPerson2": { "properties": { "person_first_name": { "title": "First name of the additional person.", "type": "string" }, "person_last_name": { "title": "Last name of the additional person.", "type": "string" }, "person_email": { "title": "E-mail address of the additional person.", "type": "string" }, "person_phone": { "title": "Phone number of the additional person.", "type": "string" }, "person_address": { "title": "Address of the additional person, as text.", "type": "string" }, "person_address_street_level": { "title": "Street and house number of the additional person's address.", "type": "string" }, "person_address_co": { "title": "Care-of line of the additional person's address.", "type": "string" }, "person_address_city": { "title": "City of the additional person's address.", "type": "string" }, "person_address_zip": { "title": "Postal code of the additional person's address.", "type": "string" }, "person_address_country": { "title": "Country of the additional person's address.", "type": "string" }, "person_birthday": { "title": "Birthday of the additional person.", "type": "string", "format": "date-time" }, "person_gender": { "title": "Gender of the additional person.", "type": "string" }, "person_grade_level": { "title": "Grade level of the additional person.", "type": "integer" }, "person_school_class": { "title": "School class of the additional person.", "type": "string" }, "person_category": { "title": "Category of the additional person.", "type": "string" }, "ticket_ticket_type": { "title": "Ticket type for the additional person's ticket.", "type": "string" }, "ticket_issuetype": { "title": "Issue type for the additional person's ticket.", "type": "string" }, "ticket_issue_category": { "title": "Issue category for the additional person's ticket.", "type": "string" }, "ticket_headline": { "title": "Headline of the additional person's ticket.", "type": "string" }, "ticket_description": { "title": "Description of the additional person's ticket.", "type": "string" } }, "type": "object" }, "SelfSignUpLogInviteCode": { "properties": { "id": { "title": "Primary key of the invite code.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token of the invite code.", "type": "string" }, "product": { "title": "Billing item the invite code applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem3" } ] }, "log_book_entry_content_type": { "title": "Content type of the log book entry created by the invite code.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "unified_category": { "$ref": "#\/components\/schemas\/UnifiedCategory4" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "SelfSignUpLogInviteCode2": { "properties": { "id": { "title": "Primary key of the invite code.", "description": "Internal ID.", "type": "integer" }, "token": { "title": "Token of the invite code.", "type": "string" }, "log_book_entry_content_type": { "title": "Content type of the log book entry created by the invite code.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "SepaPaymentTransaction": { "properties": { "duplicate_warning": { "type": "boolean" }, "auto": { "title": "The transaction was created automatically.", "type": "boolean" }, "incoming": { "title": "The transaction is incoming money.", "type": "boolean" }, "currency": { "title": "Currency of the transaction, for example EUR.", "type": "string" }, "brutto_value": { "title": "Gross amount of the transaction.", "type": "number", "format": "float" }, "duplicate_owner_value_warning": { "title": "Not persisted. Set by the api when another transaction of the same generated sepa export\ndebits the same value from the same payment owner.", "type": "boolean" }, "duplicate_iban_value_warning": { "title": "Not persisted. Set by the api when another transaction of the same generated sepa export\ndebits the same value from the same iban.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "SepaPaymentTransaction2": { "properties": { "company": { "$ref": "#\/components\/schemas\/CRMCompany23" }, "auto": { "title": "The transaction was created automatically.", "type": "boolean" }, "incoming": { "title": "The transaction is incoming money.", "type": "boolean" }, "currency": { "title": "Currency of the transaction, for example EUR.", "type": "string" }, "brutto_value": { "title": "Gross amount of the transaction.", "type": "number", "format": "float" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "payment_owner": { "title": "Account owner of the direct debit.", "type": "string" }, "payment_institution": { "title": "Name of the bank of the direct debit.", "type": "string" }, "payment_bic": { "title": "BIC of the bank account.", "type": "string" }, "payment_iban": { "title": "IBAN of the bank account.", "type": "string" }, "payment_mandate": { "title": "Reference of the SEPA mandate.", "type": "string" }, "payment_mandate_sign_date": { "title": "Date the SEPA mandate was signed.", "type": "string", "format": "date-time" }, "payment_mandate_valid_until_date": { "title": "Date until which the SEPA mandate is valid.", "type": "string", "format": "date-time" }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" } }, "type": "object" }, "Session": { "properties": { "id": { "title": "Primary key of the session.", "description": "Internal ID.", "type": "integer" }, "sessionid": { "title": "ID of the session.", "type": "string" }, "selectedcustomer": { "title": "Customer profile selected in the session.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomerProfile" } ] }, "start": { "title": "Point in time the session started.", "type": "string", "format": "date-time" }, "refreshed_start": { "title": "Point in time the session was last refreshed.", "type": "string", "format": "date-time" }, "ip": { "title": "IP address of the client.", "type": "string" }, "valid": { "title": "Whether the session is valid.", "type": "boolean" }, "is_api_key": { "title": "Whether the session was created with an API key.", "type": "boolean" }, "is_dg": { "title": "Whether the session is for the DG (member organization) context.", "type": "boolean" }, "missing2fa": { "title": "Whether two-factor authentication is still missing.", "type": "boolean" }, "start_in_vpn": { "title": "Whether the session started in a VPN.", "type": "boolean" }, "auth_by_credentials": { "title": "Whether the session was authenticated with user name and password.", "type": "boolean" }, "auth_by_google": { "title": "Whether the session was authenticated with Google.", "type": "boolean" }, "auth_by_microsoft": { "title": "Whether the session was authenticated with Microsoft.", "type": "boolean" }, "auth_by_cloudflare": { "title": "Whether the session was authenticated with Cloudflare Access.", "type": "boolean" } }, "type": "object" }, "Session2": { "properties": { "id": { "title": "Primary key of the session.", "description": "Internal ID.", "type": "integer" }, "sessionid": { "title": "ID of the session.", "type": "string" }, "user": { "title": "User the session belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User4" } ] }, "selectedcustomer": { "title": "Customer profile selected in the session.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomerProfile" } ] }, "start": { "title": "Point in time the session started.", "type": "string", "format": "date-time" }, "refreshed_start": { "title": "Point in time the session was last refreshed.", "type": "string", "format": "date-time" }, "ip": { "title": "IP address of the client.", "type": "string" }, "valid": { "title": "Whether the session is valid.", "type": "boolean" }, "is_api_key": { "title": "Whether the session was created with an API key.", "type": "boolean" }, "is_dg": { "title": "Whether the session is for the DG (member organization) context.", "type": "boolean" }, "missing2fa": { "title": "Whether two-factor authentication is still missing.", "type": "boolean" }, "start_in_vpn": { "title": "Whether the session started in a VPN.", "type": "boolean" }, "auth_by_credentials": { "title": "Whether the session was authenticated with user name and password.", "type": "boolean" }, "auth_by_google": { "title": "Whether the session was authenticated with Google.", "type": "boolean" }, "auth_by_microsoft": { "title": "Whether the session was authenticated with Microsoft.", "type": "boolean" }, "auth_by_cloudflare": { "title": "Whether the session was authenticated with Cloudflare Access.", "type": "boolean" } }, "type": "object" }, "Session3": { "properties": { "id": { "title": "Primary key of the session.", "description": "Internal ID.", "type": "integer" }, "sessionid": { "title": "ID of the session.", "type": "string" }, "user": { "title": "User the session belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User5" } ] }, "selectedcustomer": { "title": "Customer profile selected in the session.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomerProfile" } ] }, "start": { "title": "Point in time the session started.", "type": "string", "format": "date-time" }, "refreshed_start": { "title": "Point in time the session was last refreshed.", "type": "string", "format": "date-time" }, "ip": { "title": "IP address of the client.", "type": "string" }, "valid": { "title": "Whether the session is valid.", "type": "boolean" }, "is_api_key": { "title": "Whether the session was created with an API key.", "type": "boolean" }, "is_dg": { "title": "Whether the session is for the DG (member organization) context.", "type": "boolean" }, "missing2fa": { "title": "Whether two-factor authentication is still missing.", "type": "boolean" }, "start_in_vpn": { "title": "Whether the session started in a VPN.", "type": "boolean" }, "auth_by_credentials": { "title": "Whether the session was authenticated with user name and password.", "type": "boolean" }, "auth_by_google": { "title": "Whether the session was authenticated with Google.", "type": "boolean" }, "auth_by_microsoft": { "title": "Whether the session was authenticated with Microsoft.", "type": "boolean" }, "auth_by_cloudflare": { "title": "Whether the session was authenticated with Cloudflare Access.", "type": "boolean" } }, "type": "object" }, "ShiftExchangeRequest": { "properties": { "source_shift": { "title": "Shift that should be exchanged.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftPlanEntry2" } ] }, "mode": { "title": "Mode of the exchange, for example swap or give away.", "type": "string" } }, "type": "object" }, "ShiftExchangeRequest2": { "properties": { "id": { "title": "Primary key of the shift exchange request.", "description": "Internal ID.", "type": "integer" }, "lock_version": { "title": "Version used to prevent parallel changes to the request.", "type": "integer" }, "source_shift": { "title": "Shift that should be exchanged.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftPlanEntry" } ] }, "target_shift": { "title": "Shift that is offered in exchange.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftPlanEntry" } ] }, "owner": { "title": "Person who owns the source shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "candidate": { "title": "Person who is asked to take the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "decided_by": { "title": "Login user who decided on the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "mode": { "title": "Mode of the exchange, for example swap or give away.", "type": "string" }, "state": { "title": "State of the request, for example open, confirmed or decided.", "type": "string" }, "source_version": { "title": "Version of the source shift at the time of the request.", "type": "integer" }, "target_version": { "title": "Version of the target shift at the time of the request.", "type": "integer" }, "owner_confirmed_at": { "title": "Time the owner confirmed the exchange.", "type": "string", "format": "date-time" }, "candidate_confirmed_at": { "title": "Time the candidate confirmed the exchange.", "type": "string", "format": "date-time" }, "decided_at": { "title": "Time the request was decided.", "type": "string", "format": "date-time" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftPlanEntry": { "properties": { "id": { "title": "Primary key of the shift plan entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user assigned to the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person assigned to the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "employment_contract_group": { "title": "Planning container - mandatory even when a person of another group helps out.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "shift_type": { "title": "Origin type - times were copied, the reference is informational.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftType4" } ] }, "start": { "title": "Start of the shift.", "type": "string", "format": "date-time" }, "end": { "title": "End of the shift.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the shift as text.", "type": "string" }, "start_month": { "title": "Month of the shift.", "type": "integer" }, "start_year": { "title": "Year of the shift.", "type": "integer" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "duration": { "title": "Target seconds: (end - start) - break, maintained by recalculate().", "type": "integer" }, "required_qualification": { "title": "Qualification required for the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification3" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "status": { "title": "Status of the shift, for example planned or published.", "type": "string" }, "published_at": { "title": "Time the shift was published.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the shift.", "type": "string" }, "has_warning": { "title": "Persisted conflict flag for list badges - the concrete warnings are computed on\ndemand (ShiftPlanHelper) and returned transiently.", "type": "boolean" }, "availability_booking": { "title": "L35: the availability the published shift stands for in the booking area (kept in\nstep by ShiftBookingSyncHelper while the sync is switched on for the contract).", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "booking": { "title": "L35: the appointment created from this shift, if any.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "lock_version": { "title": "Optimistic lock. Two planners editing the same shift, or publishing a week while\nsomeone else moves a shift inside it, would otherwise silently overwrite each\nother - the loser now gets a 409 instead.", "description": "Read only: Doctrine owns the value, the client echoes the one it last saw back as\nthe lock_version query parameter.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftPlanEntry2": { "properties": { "start": { "title": "Start of the shift.", "type": "string", "format": "date-time" }, "end": { "title": "End of the shift.", "type": "string", "format": "date-time" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "description": { "title": "Description of the shift.", "type": "string" } }, "type": "object" }, "ShiftPlanEntry3": { "properties": { "opened_absence_type": { "title": "The absence type as a plain label, so the planning can show \"Krank\" without\npulling the whole request into every shift.", "type": "string" }, "id": { "title": "Primary key of the shift plan entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user assigned to the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person assigned to the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "contract": { "title": "Contract the shift is planned on.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract5" } ] }, "employment_contract_group": { "title": "Planning container - mandatory even when a person of another group helps out.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "shift_type": { "title": "Origin type - times were copied, the reference is informational.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftType5" } ] }, "start": { "title": "Start of the shift.", "type": "string", "format": "date-time" }, "end": { "title": "End of the shift.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the shift as text.", "type": "string" }, "start_month": { "title": "Month of the shift.", "type": "integer" }, "start_year": { "title": "Year of the shift.", "type": "integer" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "duration": { "title": "Target seconds: (end - start) - break, maintained by recalculate().", "type": "integer" }, "required_qualification": { "title": "Qualification required for the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification5" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "status": { "title": "Status of the shift, for example planned or published.", "type": "string" }, "published_at": { "title": "Time the shift was published.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the shift.", "type": "string" }, "has_warning": { "title": "Persisted conflict flag for list badges - the concrete warnings are computed on\ndemand (ShiftPlanHelper) and returned transiently.", "type": "boolean" }, "availability_booking": { "title": "L35: the availability the published shift stands for in the booking area (kept in\nstep by ShiftBookingSyncHelper while the sync is switched on for the contract).", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "booking": { "title": "L35: the appointment created from this shift, if any.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "opened_reason": { "title": "Reason the shift was opened for other staff.", "type": "string" }, "opened_at": { "title": "Time the shift was opened.", "type": "string", "format": "date-time" }, "opened_from_person": { "title": "Who worked the shift before it became open - the assignment itself is gone, and the\nplanning has to know whom to ask.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "opened_absence_request": { "title": "The absence that freed it, for OPENED_REASON_ABSENCE. Carries the type and the days,\nso the planning sees \"sick\" instead of only \"somebody is away\".", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeRequest5" } ] }, "lock_version": { "title": "Optimistic lock. Two planners editing the same shift, or publishing a week while\nsomeone else moves a shift inside it, would otherwise silently overwrite each\nother - the loser now gets a 409 instead.", "description": "Read only: Doctrine owns the value, the client echoes the one it last saw back as\nthe lock_version query parameter.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftPlanEntry6": { "properties": { "id": { "title": "Primary key of the shift plan entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user assigned to the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person assigned to the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "employment_contract_group": { "title": "Planning container - mandatory even when a person of another group helps out.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "shift_type": { "title": "Origin type - times were copied, the reference is informational.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftType6" } ] }, "start": { "title": "Start of the shift.", "type": "string", "format": "date-time" }, "end": { "title": "End of the shift.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the shift as text.", "type": "string" }, "start_month": { "title": "Month of the shift.", "type": "integer" }, "start_year": { "title": "Year of the shift.", "type": "integer" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "duration": { "title": "Target seconds: (end - start) - break, maintained by recalculate().", "type": "integer" }, "required_qualification": { "title": "Qualification required for the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification23" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "status": { "title": "Status of the shift, for example planned or published.", "type": "string" }, "published_at": { "title": "Time the shift was published.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the shift.", "type": "string" }, "has_warning": { "title": "Persisted conflict flag for list badges - the concrete warnings are computed on\ndemand (ShiftPlanHelper) and returned transiently.", "type": "boolean" }, "availability_booking": { "title": "L35: the availability the published shift stands for in the booking area (kept in\nstep by ShiftBookingSyncHelper while the sync is switched on for the contract).", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "booking": { "title": "L35: the appointment created from this shift, if any.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "lock_version": { "title": "Optimistic lock. Two planners editing the same shift, or publishing a week while\nsomeone else moves a shift inside it, would otherwise silently overwrite each\nother - the loser now gets a 409 instead.", "description": "Read only: Doctrine owns the value, the client echoes the one it last saw back as\nthe lock_version query parameter.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftPlanEntry7": { "properties": { "opened_absence_type": { "title": "The absence type as a plain label, so the planning can show \"Krank\" without\npulling the whole request into every shift.", "type": "string" }, "id": { "title": "Primary key of the shift plan entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user assigned to the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person assigned to the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "contract": { "title": "Contract the shift is planned on.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract19" } ] }, "employment_contract_group": { "title": "Planning container - mandatory even when a person of another group helps out.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "shift_type": { "title": "Origin type - times were copied, the reference is informational.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftType7" } ] }, "start": { "title": "Start of the shift.", "type": "string", "format": "date-time" }, "end": { "title": "End of the shift.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the shift as text.", "type": "string" }, "start_month": { "title": "Month of the shift.", "type": "integer" }, "start_year": { "title": "Year of the shift.", "type": "integer" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "duration": { "title": "Target seconds: (end - start) - break, maintained by recalculate().", "type": "integer" }, "required_qualification": { "title": "Qualification required for the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification24" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "status": { "title": "Status of the shift, for example planned or published.", "type": "string" }, "published_at": { "title": "Time the shift was published.", "type": "string", "format": "date-time" }, "description": { "title": "Description of the shift.", "type": "string" }, "has_warning": { "title": "Persisted conflict flag for list badges - the concrete warnings are computed on\ndemand (ShiftPlanHelper) and returned transiently.", "type": "boolean" }, "availability_booking": { "title": "L35: the availability the published shift stands for in the booking area (kept in\nstep by ShiftBookingSyncHelper while the sync is switched on for the contract).", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "booking": { "title": "L35: the appointment created from this shift, if any.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "opened_reason": { "title": "Reason the shift was opened for other staff.", "type": "string" }, "opened_at": { "title": "Time the shift was opened.", "type": "string", "format": "date-time" }, "opened_from_person": { "title": "Who worked the shift before it became open - the assignment itself is gone, and the\nplanning has to know whom to ask.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "opened_absence_request": { "title": "The absence that freed it, for OPENED_REASON_ABSENCE. Carries the type and the days,\nso the planning sees \"sick\" instead of only \"somebody is away\".", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeRequest7" } ] }, "lock_version": { "title": "Optimistic lock. Two planners editing the same shift, or publishing a week while\nsomeone else moves a shift inside it, would otherwise silently overwrite each\nother - the loser now gets a 409 instead.", "description": "Read only: Doctrine owns the value, the client echoes the one it last saw back as\nthe lock_version query parameter.", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftPlanTemplate": { "properties": { "id": { "title": "Primary key of the shift plan template.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Contract group the template is for.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftPlanTemplate2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "ShiftPlanTemplate3": { "properties": { "id": { "title": "Primary key of the shift plan template.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Contract group the template is for.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "entries": { "title": "Entries of the template.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ShiftPlanTemplateEntry" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftPlanTemplateEntry": { "properties": { "id": { "title": "Primary key of the shift plan template entry.", "description": "Internal ID.", "type": "integer" }, "iso_weekday": { "title": "ISO weekday, 1 = Monday ... 7 = Sunday.", "type": "integer" }, "shift_type": { "title": "Shift type of the entry.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftType3" } ] }, "start_time": { "title": "Start time of the shift in HH:MM.", "type": "string" }, "end_time": { "title": "End time of the shift in HH:MM.", "type": "string" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "staff_count": { "title": "Number of staff needed for the shift.", "type": "integer" }, "required_qualification": { "title": "Qualification required for the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" } }, "type": "object" }, "ShiftType": { "properties": { "id": { "title": "Primary key of the shift type.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Group this type belongs to (null = available for the whole organization \/\ninstallation).", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "employment_organization": { "title": "Organization the shift type belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization" } ] }, "short_name": { "title": "Short code for grids and print (\"F\", \"S\", \"N\").", "type": "string" }, "start_time": { "title": "Default start time as HH:MM.", "type": "string" }, "end_time": { "title": "Default end time as HH:MM - an end time before the start time means the shift ends\non the following day (night shift).", "type": "string" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "color": { "title": "Color of the shift type in the shift plan, as hex code.", "type": "string" }, "required_qualification": { "title": "Default qualification requirement for shifts of this type.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification4" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "default_staff_count": { "title": "Default number of staff needed for the shift.", "type": "integer" }, "sort_order": { "title": "Sort order of the shift type in lists.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftType2": { "properties": { "short_name": { "title": "Short code for grids and print (\"F\", \"S\", \"N\").", "type": "string" }, "start_time": { "title": "Default start time as HH:MM.", "type": "string" }, "end_time": { "title": "Default end time as HH:MM - an end time before the start time means the shift ends\non the following day (night shift).", "type": "string" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "color": { "title": "Color of the shift type in the shift plan, as hex code.", "type": "string" }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "default_staff_count": { "title": "Default number of staff needed for the shift.", "type": "integer" }, "sort_order": { "title": "Sort order of the shift type in lists.", "type": "integer" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "ShiftType3": { "properties": { "id": { "title": "Primary key of the shift type.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Group this type belongs to (null = available for the whole organization \/\ninstallation).", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "employment_organization": { "title": "Organization the shift type belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization2" } ] }, "short_name": { "title": "Short code for grids and print (\"F\", \"S\", \"N\").", "type": "string" }, "start_time": { "title": "Default start time as HH:MM.", "type": "string" }, "end_time": { "title": "Default end time as HH:MM - an end time before the start time means the shift ends\non the following day (night shift).", "type": "string" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "color": { "title": "Color of the shift type in the shift plan, as hex code.", "type": "string" }, "required_qualification": { "title": "Default qualification requirement for shifts of this type.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "default_staff_count": { "title": "Default number of staff needed for the shift.", "type": "integer" }, "sort_order": { "title": "Sort order of the shift type in lists.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftType4": { "properties": { "id": { "title": "Primary key of the shift type.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Group this type belongs to (null = available for the whole organization \/\ninstallation).", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "employment_organization": { "title": "Organization the shift type belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization5" } ] }, "short_name": { "title": "Short code for grids and print (\"F\", \"S\", \"N\").", "type": "string" }, "start_time": { "title": "Default start time as HH:MM.", "type": "string" }, "end_time": { "title": "Default end time as HH:MM - an end time before the start time means the shift ends\non the following day (night shift).", "type": "string" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "color": { "title": "Color of the shift type in the shift plan, as hex code.", "type": "string" }, "required_qualification": { "title": "Default qualification requirement for shifts of this type.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification3" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "default_staff_count": { "title": "Default number of staff needed for the shift.", "type": "integer" }, "sort_order": { "title": "Sort order of the shift type in lists.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftType5": { "properties": { "id": { "title": "Primary key of the shift type.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Group this type belongs to (null = available for the whole organization \/\ninstallation).", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "employment_organization": { "title": "Organization the shift type belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization8" } ] }, "short_name": { "title": "Short code for grids and print (\"F\", \"S\", \"N\").", "type": "string" }, "start_time": { "title": "Default start time as HH:MM.", "type": "string" }, "end_time": { "title": "Default end time as HH:MM - an end time before the start time means the shift ends\non the following day (night shift).", "type": "string" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "color": { "title": "Color of the shift type in the shift plan, as hex code.", "type": "string" }, "required_qualification": { "title": "Default qualification requirement for shifts of this type.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification5" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "default_staff_count": { "title": "Default number of staff needed for the shift.", "type": "integer" }, "sort_order": { "title": "Sort order of the shift type in lists.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftType6": { "properties": { "id": { "title": "Primary key of the shift type.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Group this type belongs to (null = available for the whole organization \/\ninstallation).", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "employment_organization": { "title": "Organization the shift type belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization9" } ] }, "short_name": { "title": "Short code for grids and print (\"F\", \"S\", \"N\").", "type": "string" }, "start_time": { "title": "Default start time as HH:MM.", "type": "string" }, "end_time": { "title": "Default end time as HH:MM - an end time before the start time means the shift ends\non the following day (night shift).", "type": "string" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "color": { "title": "Color of the shift type in the shift plan, as hex code.", "type": "string" }, "required_qualification": { "title": "Default qualification requirement for shifts of this type.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification23" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "default_staff_count": { "title": "Default number of staff needed for the shift.", "type": "integer" }, "sort_order": { "title": "Sort order of the shift type in lists.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShiftType7": { "properties": { "id": { "title": "Primary key of the shift type.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Group this type belongs to (null = available for the whole organization \/\ninstallation).", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "employment_organization": { "title": "Organization the shift type belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization10" } ] }, "short_name": { "title": "Short code for grids and print (\"F\", \"S\", \"N\").", "type": "string" }, "start_time": { "title": "Default start time as HH:MM.", "type": "string" }, "end_time": { "title": "Default end time as HH:MM - an end time before the start time means the shift ends\non the following day (night shift).", "type": "string" }, "break_duration_seconds": { "title": "Break duration of the shift in seconds.", "type": "integer" }, "color": { "title": "Color of the shift type in the shift plan, as hex code.", "type": "string" }, "required_qualification": { "title": "Default qualification requirement for shifts of this type.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification24" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "default_staff_count": { "title": "Default number of staff needed for the shift.", "type": "integer" }, "sort_order": { "title": "Sort order of the shift type in lists.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShortLink": { "properties": { "id": { "title": "Primary key of the short link.", "description": "Internal ID.", "type": "integer" }, "short_text": { "title": "Short text of the link, used in the URL.", "type": "string" }, "long_text": { "title": "Target URL the short link redirects to.", "type": "string" }, "description": { "title": "Description of the short link.", "type": "string" }, "content_type": { "title": "Type of the content the link points to.", "type": "string" }, "archived": { "title": "Whether the short link is archived.", "type": "boolean" }, "clicks_today": { "title": "Number of clicks today.", "type": "integer" }, "clicks_week": { "title": "Number of clicks this week.", "type": "integer" }, "clicks_year": { "title": "Number of clicks this year.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "ShortLink2": { "properties": { "short_text": { "title": "Short text of the link, used in the URL.", "type": "string" }, "long_text": { "title": "Target URL the short link redirects to.", "type": "string" }, "description": { "title": "Description of the short link.", "type": "string" }, "content_type": { "title": "Type of the content the link points to.", "type": "string" }, "utm_id": { "title": "UTM ID used for tracking.", "type": "string" }, "utm_source": { "title": "UTM source used for tracking.", "type": "string" }, "utm_medium": { "title": "UTM medium used for tracking.", "type": "string" }, "utm_campaign": { "title": "UTM campaign used for tracking.", "type": "string" }, "utm_term": { "title": "UTM term used for tracking.", "type": "string" }, "utm_content": { "title": "UTM content used for tracking.", "type": "string" }, "tracking_provider": { "title": "Tracking provider of the link.", "type": "string" }, "archived": { "title": "Whether the short link is archived.", "type": "boolean" } }, "type": "object" }, "ShortLink3": { "properties": { "full_url": { "type": "string" }, "id": { "title": "Primary key of the short link.", "description": "Internal ID.", "type": "integer" }, "short_text": { "title": "Short text of the link, used in the URL.", "type": "string" }, "long_text": { "title": "Target URL the short link redirects to.", "type": "string" }, "description": { "title": "Description of the short link.", "type": "string" }, "content_type": { "title": "Type of the content the link points to.", "type": "string" }, "utm_id": { "title": "UTM ID used for tracking.", "type": "string" }, "utm_source": { "title": "UTM source used for tracking.", "type": "string" }, "utm_medium": { "title": "UTM medium used for tracking.", "type": "string" }, "utm_campaign": { "title": "UTM campaign used for tracking.", "type": "string" }, "utm_term": { "title": "UTM term used for tracking.", "type": "string" }, "utm_content": { "title": "UTM content used for tracking.", "type": "string" }, "tracking_provider": { "title": "Tracking provider of the link.", "type": "string" }, "archived": { "title": "Whether the short link is archived.", "type": "boolean" }, "clicks_today": { "title": "Number of clicks today.", "type": "integer" }, "clicks_week": { "title": "Number of clicks this week.", "type": "integer" }, "clicks_year": { "title": "Number of clicks this year.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "SimpleChange": { "properties": { "id": { "description": "The ID of the entity to change, can be a string or an integer", "type": "mixed" }, "action": { "description": "The action to perform on the entity", "type": "string", "nullable": true }, "property": { "description": "The property to change on the entity", "type": "string", "nullable": true }, "new_value": { "description": "The new value to set for the property", "type": "mixed", "nullable": true }, "done": { "description": "Indicates if the change has been processed", "type": "boolean" } }, "type": "object" }, "SimpleDynamicResponse": { "type": "object" }, "SimpleReference": { "properties": { "class_name": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "SmartLock": { "properties": { "id": { "title": "Primary key of the smart lock.", "description": "Internal ID.", "type": "integer" }, "type": { "title": "Type of the smart lock, for example door or gate.", "type": "string" }, "base_bookable": { "title": "Bookable the smart lock opens.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookable4" } ] }, "employment_contracts": { "title": "Linked employment contracts", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentContract16" } }, "employment_contract_groups": { "title": "Linked employment contract groups", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } }, "connection": { "title": "Connection used to control the smart lock.", "oneOf": [ { "$ref": "#\/components\/schemas\/SmartLockConnection3" } ] }, "provider_device_id": { "title": "ID of the device at the provider.", "type": "string" }, "provider_device_type": { "title": "Type of the device at the provider.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "self_service_type": { "title": "Type of the self-service option.", "type": "string" }, "arslist_self_service": { "title": "Access rights list that controls the self-service option.", "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessRightStorage2" } }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "SmartLock2": { "properties": { "type": { "title": "Type of the smart lock, for example door or gate.", "type": "string" }, "base_bookable": { "title": "Bookable the smart lock opens.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBookable17" } ] }, "employment_contracts": { "title": "Linked employment contracts", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentContract17" } }, "employment_contract_groups": { "title": "Linked employment contract groups", "type": "array", "items": { "$ref": "#\/components\/schemas\/EmploymentContractGroup8" } }, "connection": { "title": "Connection used to control the smart lock.", "oneOf": [ { "$ref": "#\/components\/schemas\/SmartLockConnection4" } ] }, "provider_device_id": { "title": "ID of the device at the provider.", "type": "string" }, "provider_device_type": { "title": "Type of the device at the provider.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "SmartLock3": { "properties": { "id": { "title": "Primary key of the smart lock.", "description": "Internal ID.", "type": "integer" }, "type": { "title": "Type of the smart lock, for example door or gate.", "type": "string" }, "provider_device_id": { "title": "ID of the device at the provider.", "type": "string" }, "provider_device_type": { "title": "Type of the device at the provider.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "SmartLockConnection": { "properties": { "scan_webhook_token": { "title": "The token the provider authenticates its scan webhook requests with (Comydo: bearer token,\nbasic auth password or \"Auth-Key\" header). The admin hands it to the provider.", "type": "string" }, "scan_webhook_path": { "title": "Path of the scan webhook of this connection's provider, relative to the API host.", "type": "string" }, "scan_webhook_signing_secret_set": { "type": "boolean" }, "id": { "title": "Primary key of the smart lock connection.", "description": "Internal ID.", "type": "integer" }, "provider": { "title": "Provider of the smart lock, for example LOQED or a bridge.", "type": "string" }, "mode": { "title": "Mode of the connection, for example bridge or web.", "type": "string" }, "bridge_host": { "title": "Host name of the bridge that talks to the lock.", "type": "string" }, "bridge_port": { "title": "Port of the bridge.", "type": "integer" }, "web_client_id": { "title": "Client ID for the web connection to the provider.", "type": "string" }, "access_token_expires_at": { "title": "Time the access token expires.", "type": "string", "format": "date-time" }, "loqed_lock_id": { "title": "ID of the LOQED lock at the provider.", "type": "string" }, "ha_instance_id": { "title": "Instance that offers its locks through this connection: the Home Assistant core uuid or the\nid of a Node-RED lock bridge or n8n lock trigger. The ha_* fields are shared by these providers.", "type": "string" }, "ha_webhook_url": { "title": "Webhook of the Home Assistant integration (or of a Node-RED instance in push mode) that\nreceives the signed lock commands.", "type": "string" }, "scan_device_ids": { "title": "Ids of the scanners of a scan webhook connection (Comydo: 12 hex digits each), separated by\ncomma, space or new line. Every id becomes one smart lock when the connection is synced.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "SmartLockConnection2": { "properties": { "provider": { "title": "Provider of the smart lock, for example LOQED or a bridge.", "type": "string" }, "mode": { "title": "Mode of the connection, for example bridge or web.", "type": "string" }, "bridge_host": { "title": "Host name of the bridge that talks to the lock.", "type": "string" }, "bridge_port": { "title": "Port of the bridge.", "type": "integer" }, "web_client_id": { "title": "Client ID for the web connection to the provider.", "type": "string" }, "loqed_lock_id": { "title": "ID of the LOQED lock at the provider.", "type": "string" }, "scan_device_ids": { "title": "Ids of the scanners of a scan webhook connection (Comydo: 12 hex digits each), separated by\ncomma, space or new line. Every id becomes one smart lock when the connection is synced.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "SmartLockConnection3": { "properties": { "id": { "title": "Primary key of the smart lock connection.", "description": "Internal ID.", "type": "integer" }, "provider": { "title": "Provider of the smart lock, for example LOQED or a bridge.", "type": "string" }, "mode": { "title": "Mode of the connection, for example bridge or web.", "type": "string" }, "bridge_host": { "title": "Host name of the bridge that talks to the lock.", "type": "string" }, "bridge_port": { "title": "Port of the bridge.", "type": "integer" }, "loqed_lock_id": { "title": "ID of the LOQED lock at the provider.", "type": "string" }, "ha_instance_id": { "title": "Instance that offers its locks through this connection: the Home Assistant core uuid or the\nid of a Node-RED lock bridge or n8n lock trigger. The ha_* fields are shared by these providers.", "type": "string" }, "ha_webhook_url": { "title": "Webhook of the Home Assistant integration (or of a Node-RED instance in push mode) that\nreceives the signed lock commands.", "type": "string" }, "scan_device_ids": { "title": "Ids of the scanners of a scan webhook connection (Comydo: 12 hex digits each), separated by\ncomma, space or new line. Every id becomes one smart lock when the connection is synced.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "SmartLockConnection4": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "SmartLockLog": { "properties": { "id": { "title": "Primary key of the log entry.", "description": "Internal ID.", "type": "integer" }, "smart_lock": { "title": "Smart lock the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/SmartLock3" } ] }, "user": { "title": "Login user who triggered the action.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person of a card or member card scan, which may have no user account (Node-RED access check).", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "source": { "title": "Where the action came from: app (also the API), homeassistant, nodered, n8n or the scan webhook provider (comydo).", "type": "string" }, "action": { "title": "Action that was logged, for example open or lock.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "StaffingCoverageAlarm": { "properties": { "status": { "type": "string" }, "id": { "title": "Primary key of the staffing coverage alarm.", "description": "Internal ID.", "type": "integer" }, "requirement": { "title": "Staffing requirement that is not covered.", "oneOf": [ { "$ref": "#\/components\/schemas\/StaffingRequirement4" } ] }, "date": { "title": "Date of the alarm.", "type": "string", "format": "date-time" }, "required_count": { "title": "Number of staff required.", "type": "integer" }, "covered_count": { "title": "Number of staff available.", "type": "integer" }, "source": { "title": "WORKER (daily scan) or APPROVAL (an approval dropped the day below the minimum).", "type": "string" }, "request": { "title": "The request whose approval raised the alarm, when it was one (L54).", "oneOf": [ { "$ref": "#\/components\/schemas\/NonWorkTimeRequest4" } ] }, "notified_at": { "title": "Time the alarm was sent.", "type": "string", "format": "date-time" }, "resolved_at": { "title": "Time the alarm was resolved.", "type": "string", "format": "date-time" }, "acknowledged_at": { "title": "Time the alarm was acknowledged.", "type": "string", "format": "date-time" }, "acknowledged_by_user": { "title": "Login user who acknowledged the alarm.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "StaffingCoverageAlarm2": { "properties": {}, "type": "object" }, "StaffingCoverageAlarm3": { "properties": { "status": { "type": "string" }, "id": { "title": "Primary key of the staffing coverage alarm.", "description": "Internal ID.", "type": "integer" }, "requirement": { "title": "Staffing requirement that is not covered.", "oneOf": [ { "$ref": "#\/components\/schemas\/StaffingRequirement5" } ] }, "date": { "title": "Date of the alarm.", "type": "string", "format": "date-time" }, "required_count": { "title": "Number of staff required.", "type": "integer" }, "covered_count": { "title": "Number of staff available.", "type": "integer" }, "source": { "title": "WORKER (daily scan) or APPROVAL (an approval dropped the day below the minimum).", "type": "string" }, "notified_at": { "title": "Time the alarm was sent.", "type": "string", "format": "date-time" }, "resolved_at": { "title": "Time the alarm was resolved.", "type": "string", "format": "date-time" }, "acknowledged_at": { "title": "Time the alarm was acknowledged.", "type": "string", "format": "date-time" }, "acknowledged_by_user": { "title": "Login user who acknowledged the alarm.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "StaffingRequirement": { "properties": { "id": { "title": "Primary key of the staffing requirement.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Contract group the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "employment_organization": { "title": "Organization the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization" } ] }, "organization_unit": { "title": "R7: a rule for a whole area (OrganizationUnit) - every group of every organisation in\nit or below it. Only without group and organisation, with staffing_organization_unit_enabled.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit4" } ] }, "mode": { "title": "Mode of the requirement, for example minimum staff or exact staff.", "type": "string" }, "weekdays_bitmask": { "title": "ISO weekday bitmask the rule applies on (Mo=1 ... So=64).", "type": "integer" }, "start_time": { "title": "Start time of the requirement in HH:MM.", "type": "string" }, "end_time": { "title": "End time of the requirement in HH:MM.", "type": "string" }, "min_staff_count": { "title": "Minimum number of staff needed.", "type": "integer" }, "buffer_staff_count": { "title": "L51: people wanted on top of the minimum. Between minimum and minimum + buffer a\nself service request is either handed in with a hint for the approvers or refused,\ndepending on bufferMode (L53). 0 = no buffer.", "type": "integer" }, "buffer_mode": { "title": "L53: HINT (default) submits with a hint, BLOCK refuses a self service request that\nwould drop the day below minimum + buffer.", "type": "string" }, "required_qualification": { "title": "Optional qualification the counted people have to satisfy (equivalences and ranking\nare honoured by QualificationMatchHelper).", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification4" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "valid_from": { "title": "Rule only applies from this date on (null = always).", "type": "string", "format": "date-time" }, "valid_until": { "title": "Date until which the requirement is valid.", "type": "string", "format": "date-time" }, "applies_on_holidays": { "title": "Whether the rule also applies on public holidays of the calendar of its scope (group\ncalendar, organisation calendar, main calendar). Off by default: a closed Kita or\noffice would otherwise be reported understaffed on every holiday; a club or care home\nwith holiday operation switches it on.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "StaffingRequirement2": { "properties": { "mode": { "title": "Mode of the requirement, for example minimum staff or exact staff.", "type": "string" }, "weekdays_bitmask": { "title": "ISO weekday bitmask the rule applies on (Mo=1 ... So=64).", "type": "integer" }, "start_time": { "title": "Start time of the requirement in HH:MM.", "type": "string" }, "end_time": { "title": "End time of the requirement in HH:MM.", "type": "string" }, "min_staff_count": { "title": "Minimum number of staff needed.", "type": "integer" }, "buffer_staff_count": { "title": "L51: people wanted on top of the minimum. Between minimum and minimum + buffer a\nself service request is either handed in with a hint for the approvers or refused,\ndepending on bufferMode (L53). 0 = no buffer.", "type": "integer" }, "buffer_mode": { "title": "L53: HINT (default) submits with a hint, BLOCK refuses a self service request that\nwould drop the day below minimum + buffer.", "type": "string" }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "valid_from": { "title": "Rule only applies from this date on (null = always).", "type": "string", "format": "date-time" }, "valid_until": { "title": "Date until which the requirement is valid.", "type": "string", "format": "date-time" }, "applies_on_holidays": { "title": "Whether the rule also applies on public holidays of the calendar of its scope (group\ncalendar, organisation calendar, main calendar). Off by default: a closed Kita or\noffice would otherwise be reported understaffed on every holiday; a club or care home\nwith holiday operation switches it on.", "type": "boolean" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "StaffingRequirement3": { "properties": { "id": { "title": "Primary key of the staffing requirement.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Contract group the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "employment_organization": { "title": "Organization the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization2" } ] }, "organization_unit": { "title": "R7: a rule for a whole area (OrganizationUnit) - every group of every organisation in\nit or below it. Only without group and organisation, with staffing_organization_unit_enabled.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit5" } ] }, "mode": { "title": "Mode of the requirement, for example minimum staff or exact staff.", "type": "string" }, "weekdays_bitmask": { "title": "ISO weekday bitmask the rule applies on (Mo=1 ... So=64).", "type": "integer" }, "start_time": { "title": "Start time of the requirement in HH:MM.", "type": "string" }, "end_time": { "title": "End time of the requirement in HH:MM.", "type": "string" }, "min_staff_count": { "title": "Minimum number of staff needed.", "type": "integer" }, "buffer_staff_count": { "title": "L51: people wanted on top of the minimum. Between minimum and minimum + buffer a\nself service request is either handed in with a hint for the approvers or refused,\ndepending on bufferMode (L53). 0 = no buffer.", "type": "integer" }, "buffer_mode": { "title": "L53: HINT (default) submits with a hint, BLOCK refuses a self service request that\nwould drop the day below minimum + buffer.", "type": "string" }, "required_qualification": { "title": "Optional qualification the counted people have to satisfy (equivalences and ranking\nare honoured by QualificationMatchHelper).", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "valid_from": { "title": "Rule only applies from this date on (null = always).", "type": "string", "format": "date-time" }, "valid_until": { "title": "Date until which the requirement is valid.", "type": "string", "format": "date-time" }, "applies_on_holidays": { "title": "Whether the rule also applies on public holidays of the calendar of its scope (group\ncalendar, organisation calendar, main calendar). Off by default: a closed Kita or\noffice would otherwise be reported understaffed on every holiday; a club or care home\nwith holiday operation switches it on.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "StaffingRequirement4": { "properties": { "id": { "title": "Primary key of the staffing requirement.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Contract group the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "employment_organization": { "title": "Organization the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization6" } ] }, "organization_unit": { "title": "R7: a rule for a whole area (OrganizationUnit) - every group of every organisation in\nit or below it. Only without group and organisation, with staffing_organization_unit_enabled.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit6" } ] }, "mode": { "title": "Mode of the requirement, for example minimum staff or exact staff.", "type": "string" }, "weekdays_bitmask": { "title": "ISO weekday bitmask the rule applies on (Mo=1 ... So=64).", "type": "integer" }, "start_time": { "title": "Start time of the requirement in HH:MM.", "type": "string" }, "end_time": { "title": "End time of the requirement in HH:MM.", "type": "string" }, "min_staff_count": { "title": "Minimum number of staff needed.", "type": "integer" }, "buffer_staff_count": { "title": "L51: people wanted on top of the minimum. Between minimum and minimum + buffer a\nself service request is either handed in with a hint for the approvers or refused,\ndepending on bufferMode (L53). 0 = no buffer.", "type": "integer" }, "buffer_mode": { "title": "L53: HINT (default) submits with a hint, BLOCK refuses a self service request that\nwould drop the day below minimum + buffer.", "type": "string" }, "required_qualification": { "title": "Optional qualification the counted people have to satisfy (equivalences and ranking\nare honoured by QualificationMatchHelper).", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification8" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "valid_from": { "title": "Rule only applies from this date on (null = always).", "type": "string", "format": "date-time" }, "valid_until": { "title": "Date until which the requirement is valid.", "type": "string", "format": "date-time" }, "applies_on_holidays": { "title": "Whether the rule also applies on public holidays of the calendar of its scope (group\ncalendar, organisation calendar, main calendar). Off by default: a closed Kita or\noffice would otherwise be reported understaffed on every holiday; a club or care home\nwith holiday operation switches it on.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "StaffingRequirement5": { "properties": { "id": { "title": "Primary key of the staffing requirement.", "description": "Internal ID.", "type": "integer" }, "employment_contract_group": { "title": "Contract group the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContractGroup" } ] }, "employment_organization": { "title": "Organization the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentOrganization7" } ] }, "organization_unit": { "title": "R7: a rule for a whole area (OrganizationUnit) - every group of every organisation in\nit or below it. Only without group and organisation, with staffing_organization_unit_enabled.", "oneOf": [ { "$ref": "#\/components\/schemas\/OrganizationUnit" } ] }, "mode": { "title": "Mode of the requirement, for example minimum staff or exact staff.", "type": "string" }, "weekdays_bitmask": { "title": "ISO weekday bitmask the rule applies on (Mo=1 ... So=64).", "type": "integer" }, "start_time": { "title": "Start time of the requirement in HH:MM.", "type": "string" }, "end_time": { "title": "End time of the requirement in HH:MM.", "type": "string" }, "min_staff_count": { "title": "Minimum number of staff needed.", "type": "integer" }, "buffer_staff_count": { "title": "L51: people wanted on top of the minimum. Between minimum and minimum + buffer a\nself service request is either handed in with a hint for the approvers or refused,\ndepending on bufferMode (L53). 0 = no buffer.", "type": "integer" }, "buffer_mode": { "title": "L53: HINT (default) submits with a hint, BLOCK refuses a self service request that\nwould drop the day below minimum + buffer.", "type": "string" }, "required_qualification": { "title": "Optional qualification the counted people have to satisfy (equivalences and ranking\nare honoured by QualificationMatchHelper).", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification9" } ] }, "qualification_match_mode": { "title": "L18: EXACT demands the required qualification itself; EQUIVALENT (default, previous\nbehaviour) also accepts linked or same-group qualifications with sufficient ranking.", "type": "string" }, "valid_from": { "title": "Rule only applies from this date on (null = always).", "type": "string", "format": "date-time" }, "valid_until": { "title": "Date until which the requirement is valid.", "type": "string", "format": "date-time" }, "applies_on_holidays": { "title": "Whether the rule also applies on public holidays of the calendar of its scope (group\ncalendar, organisation calendar, main calendar). Off by default: a closed Kita or\noffice would otherwise be reported understaffed on every holiday; a club or care home\nwith holiday operation switches it on.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "StorageLocation": { "properties": { "id": { "title": "Primary key of the storage location.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "StudioDevice": { "properties": { "id": { "title": "Primary key of the studio device.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the device.", "type": "string" }, "description": { "title": "Description of the device.", "type": "string" }, "manufacturer": { "title": "Manufacturer of the device.", "type": "string" }, "model": { "title": "Model of the device.", "type": "string" }, "device_type": { "title": "Type of the device, for example treadmill or bike.", "type": "string" }, "identifier": { "title": "Identifier of the device at the manufacturer.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "StudioDeviceSetup": { "properties": { "id": { "title": "Primary key of the device setup.", "description": "Internal ID.", "type": "integer" }, "training_person_data": { "title": "Training data of the person the setup belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPersonData2" } ] }, "device": { "title": "Studio device that is set up.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioDevice" } ] }, "preset": { "title": "Training preset used for the setup.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } ] }, "name": { "title": "Name of the setup.", "type": "string" }, "notes": { "title": "Notes on the setup.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "StudioTrainingChallenge": { "properties": { "id": { "title": "Primary key of the training challenge.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the challenge.", "type": "string" }, "description": { "title": "Description of the challenge.", "type": "string" }, "start": { "title": "First moment that counts", "type": "string", "format": "date-time" }, "end": { "title": "Last moment that counts", "type": "string", "format": "date-time" }, "metric": { "title": "What is counted: training_days, sessions or checkins", "type": "string" }, "target_value": { "title": "How many of the metric complete the challenge", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "StudioTrainingMeasurement": { "properties": { "id": { "title": "Primary key of the training measurement.", "description": "Internal ID.", "type": "integer" }, "training_person_data": { "title": "Training data of the person measured.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPersonData2" } ] }, "preset": { "title": "Preset the measurement belongs to, used for strength test values", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } ] }, "measured_at": { "title": "Time of the measurement.", "type": "string", "format": "date-time" }, "measurement_type": { "title": "One of the TYPE_* constants", "type": "string" }, "value": { "title": "Measured value.", "type": "number", "format": "float" }, "unit": { "title": "Unit of the measured value.", "type": "string" }, "body_site": { "title": "Body site for girth measurements, e.g. waist, hip, chest", "type": "string" }, "source": { "title": "One of the SOURCE_* constants", "type": "string" }, "source_device": { "title": "Name of the measuring device or provider, e.g. InBody 970, seca mBCA", "type": "string" }, "notes": { "title": "Notes on the measurement.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "StudioTrainingMuscleGroup": { "properties": { "id": { "title": "Primary key of the muscle group.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the muscle group.", "type": "string" }, "body_marker_key": { "title": "Short identifier used by clients to map the group to a body diagram area", "type": "string" }, "description": { "title": "Description of the muscle group.", "type": "string" }, "is_front": { "title": "True if the muscle group is shown on the front side of the body diagram", "type": "boolean" }, "image": { "title": "Image of the muscle group.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "StudioTrainingPersonData": { "properties": { "id": { "title": "Primary key of the training person data.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the training data belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "personal_trainer": { "title": "Personal trainer of the person.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "weight": { "title": "Body weight of the person.", "type": "number", "format": "float" }, "trainer_notes": { "title": "Notes of the trainer about the person.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "StudioTrainingPersonData2": { "properties": { "id": { "title": "Primary key of the training person data.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the training data belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "personal_trainer": { "title": "Personal trainer of the person.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "weight": { "title": "Body weight of the person.", "type": "number", "format": "float" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "StudioTrainingPlan": { "properties": { "id": { "title": "Primary key of the training plan.", "description": "Internal ID.", "type": "integer" }, "training_person_data": { "title": "Training data of the person the plan is for.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPersonData2" } ] }, "name": { "title": "Name of the training plan.", "type": "string" }, "description": { "title": "Description of the training plan.", "type": "string" }, "times_per_week": { "title": "Planned number of training sessions per week.", "type": "integer" }, "status": { "title": "One of the STATUS_* constants", "type": "string" }, "is_template": { "title": "True for reusable templates that are not bound to a training person", "type": "boolean" }, "valid_from": { "title": "Start of the plan.", "type": "string", "format": "date-time" }, "valid_until": { "title": "End of the plan.", "type": "string", "format": "date-time" }, "review_date": { "title": "Date the plan should be reviewed with the member (Wiedervorlage)", "type": "string", "format": "date-time" }, "training_goal": { "title": "Training goal of the plan, e.g. muscle building, weight loss, rehab", "type": "string" }, "created_by_person": { "title": "Trainer who created the plan, kept for the training documentation", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "source_template": { "title": "Template this plan was created from, if it was assigned from a template", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "StudioTrainingPlan3": { "properties": { "id": { "title": "Primary key of the training plan.", "description": "Internal ID.", "type": "integer" }, "training_person_data": { "title": "Training data of the person the plan is for.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPersonData" } ] }, "name": { "title": "Name of the training plan.", "type": "string" }, "description": { "title": "Description of the training plan.", "type": "string" }, "times_per_week": { "title": "Planned number of training sessions per week.", "type": "integer" }, "status": { "title": "One of the STATUS_* constants", "type": "string" }, "is_template": { "title": "True for reusable templates that are not bound to a training person", "type": "boolean" }, "valid_from": { "title": "Start of the plan.", "type": "string", "format": "date-time" }, "valid_until": { "title": "End of the plan.", "type": "string", "format": "date-time" }, "review_date": { "title": "Date the plan should be reviewed with the member (Wiedervorlage)", "type": "string", "format": "date-time" }, "training_goal": { "title": "Training goal of the plan, e.g. muscle building, weight loss, rehab", "type": "string" }, "created_by_person": { "title": "Trainer who created the plan, kept for the training documentation", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "source_template": { "title": "Template this plan was created from, if it was assigned from a template", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPlan3" } ] }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "StudioTrainingPlanDay": { "properties": { "id": { "title": "Primary key of the plan day.", "description": "Internal ID.", "type": "integer" }, "plan": { "title": "Plan the day belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } ] }, "name": { "title": "Name of the plan day.", "type": "string" }, "description": { "title": "Description of the plan day.", "type": "string" }, "day_of_week": { "title": "Optional fixed weekday (1 = Monday ... 7 = Sunday) if the plan is bound to weekdays", "type": "integer" }, "rounds": { "title": "Number of rounds if the day is executed as a circuit (Zirkeltraining)", "type": "integer" }, "round_rest_seconds": { "title": "Pause between circuit rounds in seconds", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "StudioTrainingPlanDay3": { "properties": { "id": { "title": "Primary key of the plan day.", "description": "Internal ID.", "type": "integer" }, "plan": { "title": "Plan the day belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPlan3" } ] }, "name": { "title": "Name of the plan day.", "type": "string" }, "description": { "title": "Description of the plan day.", "type": "string" }, "day_of_week": { "title": "Optional fixed weekday (1 = Monday ... 7 = Sunday) if the plan is bound to weekdays", "type": "integer" }, "rounds": { "title": "Number of rounds if the day is executed as a circuit (Zirkeltraining)", "type": "integer" }, "round_rest_seconds": { "title": "Pause between circuit rounds in seconds", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "StudioTrainingPlanExercise": { "properties": { "id": { "title": "Primary key of the plan exercise.", "description": "Internal ID.", "type": "integer" }, "plan_day": { "title": "Plan day the exercise belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } ] }, "preset": { "title": "Training preset of the exercise.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } ] }, "device": { "title": "Optional concrete machine for this exercise", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioDevice" } ] }, "name": { "title": "Overrides the preset name when the trainer renamed the exercise for this plan", "type": "string" }, "sets": { "title": "Number of sets.", "type": "integer" }, "repetitions": { "title": "Number of repetitions per set.", "type": "integer" }, "repetitions_to": { "title": "Upper bound if the prescription is a repetition range (e.g. 8 - 12)", "type": "integer" }, "weight": { "title": "Weight per repetition.", "type": "number", "format": "float" }, "weight_unit": { "title": "Unit of the weight, for example kg.", "type": "string" }, "duration_seconds": { "title": "Duration of one set in seconds for time based exercises", "type": "integer" }, "rest_seconds": { "title": "Pause between sets in seconds", "type": "integer" }, "tempo": { "title": "Movement tempo notation, e.g. \"2-0-2-0\"", "type": "string" }, "intensity_percent": { "title": "Target intensity in percent of the one repetition maximum", "type": "number", "format": "float" }, "rpe": { "title": "Rate of perceived exertion \/ reps in reserve target", "type": "number", "format": "float" }, "circuit_group": { "title": "Exercises of the same day sharing this key form a superset \/ circuit block", "type": "string" }, "notes": { "title": "Notes on the exercise.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "StudioTrainingPreset": { "properties": { "id": { "title": "Primary key of the training preset.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the exercise.", "type": "string" }, "description": { "title": "Description of the exercise.", "type": "string" }, "image": { "title": "Image of the exercise.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "video": { "title": "Video of the exercise.", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "duration": { "title": "Typical duration of the exercise in seconds.", "type": "integer" }, "muscle_groups": { "title": "Primarily trained muscle groups", "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } }, "secondary_muscle_groups": { "title": "Secondarily trained muscle groups", "type": "array", "items": { "$ref": "#\/components\/schemas\/StudioTrainingMuscleGroup" } }, "exercise_type": { "title": "Category of the exercise, e.g. strength, cardio, mobility, rehab", "type": "string" }, "equipment": { "title": "Required equipment as free text, e.g. barbell, cable machine, bodyweight", "type": "string" }, "execution_notes": { "title": "Execution cues and safety notes for the member", "type": "string" }, "default_sets": { "title": "Default prescription proposed when the preset is added to a plan", "type": "integer" }, "default_repetitions": { "title": "Default number of repetitions.", "type": "integer" }, "default_rest_seconds": { "title": "Default rest time in seconds.", "type": "integer" }, "content_source": { "title": "One of the CONTENT_SOURCE_* constants", "type": "string" }, "content_source_name": { "title": "Name of the catalogue the entry was seeded from, e.g. wger", "type": "string" }, "license": { "title": "Licence of the imported content, e.g. CC-BY-SA 4.0", "type": "string" }, "license_author": { "title": "Author that has to be named to fulfil the licence attribution", "type": "string" }, "license_author_url": { "title": "Link to the author of the image or video license.", "type": "string" }, "review_status": { "title": "One of the REVIEW_STATUS_* constants, used to keep generated or imported\nexercise instructions under human control before they are published", "type": "string" }, "reviewed_at": { "title": "Time the exercise was reviewed.", "type": "string", "format": "date-time" }, "reviewed_by": { "title": "Name of the reviewer.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "StudioTrainingSession": { "properties": { "id": { "title": "Primary key of the training session.", "description": "Internal ID.", "type": "integer" }, "training_person_data": { "title": "Training data of the person who trained.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPersonData" } ] }, "plan": { "title": "Training plan the session belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPlan3" } ] }, "plan_day": { "title": "Plan day the session belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay3" } ] }, "trainer": { "title": "Trainer who supervised the unit, if any", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "performed_at": { "title": "Time the training was performed.", "type": "string", "format": "date-time" }, "duration_seconds": { "title": "Duration of the session in seconds.", "type": "integer" }, "status": { "title": "Status of the session, for example planned or done.", "type": "string" }, "source": { "title": "Source of the session, for example app or device.", "type": "string" }, "rpe": { "title": "Overall rate of perceived exertion of the unit", "type": "number", "format": "float" }, "average_heart_rate": { "title": "Average heart rate in beats per minute.", "type": "integer" }, "calories": { "title": "Calories burned.", "type": "integer" }, "notes": { "title": "Notes of the person.", "type": "string" }, "trainer_notes": { "title": "Notes of the trainer.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "StudioTrainingSession2": { "properties": { "id": { "title": "Primary key of the training session.", "description": "Internal ID.", "type": "integer" }, "training_person_data": { "title": "Training data of the person who trained.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPersonData2" } ] }, "plan": { "title": "Training plan the session belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPlan" } ] }, "plan_day": { "title": "Plan day the session belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPlanDay" } ] }, "trainer": { "title": "Trainer who supervised the unit, if any", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "performed_at": { "title": "Time the training was performed.", "type": "string", "format": "date-time" }, "duration_seconds": { "title": "Duration of the session in seconds.", "type": "integer" }, "status": { "title": "Status of the session, for example planned or done.", "type": "string" }, "source": { "title": "Source of the session, for example app or device.", "type": "string" }, "rpe": { "title": "Overall rate of perceived exertion of the unit", "type": "number", "format": "float" }, "average_heart_rate": { "title": "Average heart rate in beats per minute.", "type": "integer" }, "calories": { "title": "Calories burned.", "type": "integer" }, "notes": { "title": "Notes of the person.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "StudioTrainingSessionEntry": { "properties": { "id": { "title": "Primary key of the session entry.", "description": "Internal ID.", "type": "integer" }, "session": { "title": "Training session the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingSession2" } ] }, "plan_exercise": { "title": "Prescription this entry was performed against, if the unit followed a plan", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPlanExercise" } ] }, "preset": { "title": "Training preset performed.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioTrainingPreset" } ] }, "device": { "title": "Device used for the exercise.", "oneOf": [ { "$ref": "#\/components\/schemas\/StudioDevice" } ] }, "set_number": { "title": "Number of the set within the exercise, starting at 1", "type": "integer" }, "repetitions": { "title": "Number of repetitions performed.", "type": "integer" }, "weight": { "title": "Weight used.", "type": "number", "format": "float" }, "weight_unit": { "title": "Unit of the weight, for example kg.", "type": "string" }, "duration_seconds": { "title": "Duration of the exercise in seconds.", "type": "integer" }, "rest_seconds": { "title": "Rest time after the exercise in seconds.", "type": "integer" }, "distance": { "title": "Distance covered.", "type": "number", "format": "float" }, "rpe": { "title": "Rate of perceived exertion, from 1 to 10.", "type": "number", "format": "float" }, "completed": { "title": "The exercise was completed.", "type": "boolean" }, "notes": { "title": "Notes on the exercise.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "order": { "title": "Position of the entity in the order.", "type": "integer" } }, "type": "object" }, "SubscriptionItem": { "properties": { "id": { "title": "Primary key of the subscription item.", "description": "Internal ID.", "type": "integer" }, "crm_person": { "title": "Person the subscription belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "crm_company": { "title": "Company the subscription belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "product": { "title": "Product the subscription bills.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem5" } ] }, "start": { "title": "Start of the subscription.", "type": "string", "format": "date-time" }, "end": { "title": "End of the subscription.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the subscription was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity billed.", "type": "number", "format": "float" }, "from_log_book_entry": { "title": "The subscription was created from a log book entry.", "type": "boolean" }, "is_temporary": { "title": "The subscription is temporary.", "type": "boolean" }, "from_ticket": { "title": "The subscription was created from a ticket.", "type": "boolean" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "SubscriptionItem2": { "properties": { "id": { "title": "Primary key of the subscription item.", "description": "Internal ID.", "type": "integer" }, "crm_person": { "title": "Person the subscription belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson9" } ] }, "crm_company": { "title": "Company the subscription belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany9" } ] }, "product": { "title": "Product the subscription bills.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem6" } ] }, "start": { "title": "Start of the subscription.", "type": "string", "format": "date-time" }, "end": { "title": "End of the subscription.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the subscription was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity billed.", "type": "number", "format": "float" } }, "type": "object" }, "SubscriptionItem3": { "properties": { "id": { "title": "Primary key of the subscription item.", "description": "Internal ID.", "type": "integer" }, "crm_person": { "title": "Person the subscription belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "crm_company": { "title": "Company the subscription belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "product": { "title": "Product the subscription bills.", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem7" } ] }, "unified_category": { "title": "Category the subscription belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory7" } ] }, "start": { "title": "Start of the subscription.", "type": "string", "format": "date-time" }, "end": { "title": "End of the subscription.", "type": "string", "format": "date-time" }, "billed": { "title": "Time the subscription was billed.", "type": "string", "format": "date-time" }, "quantity": { "title": "Quantity billed.", "type": "number", "format": "float" }, "from_log_book_entry": { "title": "The subscription was created from a log book entry.", "type": "boolean" }, "log_book_entry": { "title": "Log book entry the subscription was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/PersonLogBookEntry10" } ] }, "is_temporary": { "title": "The subscription is temporary.", "type": "boolean" }, "from_ticket": { "title": "The subscription was created from a ticket.", "type": "boolean" }, "ticket": { "title": "Ticket the subscription was created from.", "oneOf": [ { "$ref": "#\/components\/schemas\/CustomerTicket5" } ] }, "billing_payment_profile": { "$ref": "#\/components\/schemas\/BillingPaymentProfile10" }, "payment_type": { "$ref": "#\/components\/schemas\/PaymentType" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "Success": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "error_codes": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "SwitchCustomerProfile": { "properties": { "customerprofile": { "type": "string" } }, "type": "object" }, "Tax": { "required": [ "name" ], "properties": { "id": { "title": "Primary key of the tax rate.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the tax rate, for example 19 percent.", "type": "string" }, "value": { "title": "Tax rate in percent.", "type": "number", "format": "float", "maximum": 1, "minimum": 0 }, "deleted": { "title": "The tax rate is deleted.", "type": "boolean" }, "global_default": { "title": "Default tax rate for new items.", "type": "boolean" }, "datev_tax_key": { "title": "DATEV Steuerschl\u00fcssel f\u00fcr Umsatzsteuer (Ausgangsrechnungen).", "description": "Wird von BuchhaltungsButler und DATEV-Export genutzt.\n\nStandardwerte:\n 0 = Kein Steuerausweis (0%)\n 2 = Umsatzsteuer 7% (erm\u00e4\u00dfigt)\n 3 = Umsatzsteuer 19% (Regelsteuersatz)\n\nF\u00fcr Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung:\n 0 = Keine Vorsteuer (0%)\n 5 = Vorsteuer 7%\n 8 = Vorsteuer 19%", "type": "integer" } }, "type": "object" }, "TicketBoardPositionRequest": { "type": "object" }, "TrainerQualification": { "properties": { "id": { "title": "Primary key of the trainer qualification.", "description": "Internal ID.", "type": "integer" }, "employment_qualification": { "title": "L16: the employee qualification this trainer qualification stands for. Trainer and\nemployee qualifications stay separate (different administration), but through this\nlink a trainer satisfies course and shift requirements with the shared group\/ranking\nrules, and the qualification editors stay where they are.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "TrainerQualification2": { "properties": { "employment_qualification": { "title": "L16: the employee qualification this trainer qualification stands for. Trainer and\nemployee qualifications stay separate (different administration), but through this\nlink a trainer satisfies course and shift requirements with the shared group\/ranking\nrules, and the qualification editors stay where they are.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentQualification2" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "TrainerTimeBilling": { "properties": { "id": { "title": "Primary key of the trainer time billing.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Trainer the billing is for.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "user": { "title": "Login user of the trainer.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "month": { "title": "Month of the billing.", "type": "integer" }, "year": { "title": "Year of the billing.", "type": "integer" }, "generation_date": { "title": "Time the billing was generated.", "type": "string", "format": "date-time" }, "total_duration": { "title": "total duration in seconds", "type": "integer" }, "total_netto_value": { "title": "Total net amount of the billing.", "type": "number", "format": "float" }, "positions": { "title": "Positions of the billing.", "type": "array", "items": { "$ref": "#\/components\/schemas\/TrainerTimeBillingPosition" } }, "instructor_allowance_yearly_amount": { "title": "Yearly instructor allowance in force when this billing was generated. Frozen, because the\nstatutory amount changes over time and a reprint has to stay consistent with the figures\nbelow. null = allowance accounting not applied.", "type": "number", "format": "float" }, "instructor_allowance_applied": { "title": "Amount of this billing that is covered by the yearly instructor allowance\n(Uebungsleiterpauschale, sec. 3 no. 26 EStG). null = allowance accounting not applied.", "type": "number", "format": "float" }, "instructor_allowance_used_before": { "title": "Yearly instructor allowance already used by previous billings of the same year\nat the time this billing was generated.", "type": "number", "format": "float" }, "instructor_allowance_remaining": { "title": "Remaining yearly instructor allowance after this billing.", "type": "number", "format": "float" }, "instructor_allowance_exceeding": { "title": "Part of this billing that exceeds the yearly instructor allowance and is therefore taxable.", "type": "number", "format": "float" } }, "type": "object" }, "TrainerTimeBillingPosition": { "properties": { "id": { "title": "Primary key of the trainer time billing position.", "description": "Internal ID.", "type": "integer" }, "trainer_time_entry": { "title": "Trainer time entry the position is based on.", "oneOf": [ { "$ref": "#\/components\/schemas\/TrainerTimeEntry3" } ] }, "date": { "title": "Date of the work.", "type": "string", "format": "date-time" }, "start_time": { "title": "Start of the work.", "type": "string", "format": "date-time" }, "end_time": { "title": "End of the work.", "type": "string", "format": "date-time" }, "duration": { "title": "duration in seconds", "type": "integer" }, "description": { "title": "Description of the work.", "type": "string" }, "netto_value": { "title": "Net value of the position.", "type": "number", "format": "float" }, "event_name": { "title": "Name of the event.", "type": "string" }, "booking_name": { "title": "Name of the booking.", "type": "string" }, "hourly_rate": { "title": "Hourly rate applied for this position", "type": "number", "format": "float" }, "is_weekend": { "title": "Whether this position falls on a weekend", "type": "boolean" }, "weekend_addition": { "title": "Weekend addition rate applied (per hour)", "type": "number", "format": "float" } }, "type": "object" }, "TrainerTimeEntry": { "properties": { "id": { "title": "Primary key of the trainer time entry.", "description": "Internal ID.", "type": "integer" }, "event": { "title": "Event the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent25" } ] }, "booking": { "title": "Booking the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "user": { "title": "User the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "description": { "title": "Description of the time entry.", "type": "string" }, "start": { "title": "Start of the time entry.", "type": "string", "format": "date-time" }, "end": { "title": "End of the time entry.", "type": "string", "format": "date-time" }, "duration": { "title": "duration in seconds", "type": "integer" }, "confirmed": { "title": "Whether the time entry is confirmed.", "type": "boolean" }, "estimated_netto_value": { "title": "Estimated net value of the time entry.", "type": "number", "format": "float" }, "considered_in_billing": { "title": "Whether the time entry is considered in billing.", "type": "boolean" }, "closed_editing": { "title": "Whether editing of the time entry is closed.", "type": "boolean" } }, "type": "object" }, "TrainerTimeEntry2": { "properties": { "event": { "title": "Event the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent9" } ] }, "booking": { "title": "Booking the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking20" } ] }, "person": { "title": "Person the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson32" } ] }, "description": { "title": "Description of the time entry.", "type": "string" }, "start": { "title": "Start of the time entry.", "type": "string", "format": "date-time" }, "end": { "title": "End of the time entry.", "type": "string", "format": "date-time" }, "duration": { "title": "duration in seconds", "type": "integer" }, "confirmed": { "title": "Whether the time entry is confirmed.", "type": "boolean" }, "considered_in_billing": { "title": "Whether the time entry is considered in billing.", "type": "boolean" }, "closed_editing": { "title": "Whether editing of the time entry is closed.", "type": "boolean" } }, "type": "object" }, "TrainerTimeEntry3": { "properties": { "id": { "title": "Primary key of the trainer time entry.", "description": "Internal ID.", "type": "integer" }, "event": { "title": "Event the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent25" } ] }, "booking": { "title": "Booking the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseBooking13" } ] }, "user": { "title": "User the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person the time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "description": { "title": "Description of the time entry.", "type": "string" }, "start": { "title": "Start of the time entry.", "type": "string", "format": "date-time" }, "end": { "title": "End of the time entry.", "type": "string", "format": "date-time" }, "duration": { "title": "duration in seconds", "type": "integer" }, "confirmed": { "title": "Whether the time entry is confirmed.", "type": "boolean" }, "estimated_netto_value": { "title": "Estimated net value of the time entry.", "type": "number", "format": "float" }, "considered_in_billing": { "title": "Whether the time entry is considered in billing.", "type": "boolean" }, "closed_editing": { "title": "Whether editing of the time entry is closed.", "type": "boolean" } }, "type": "object" }, "TravelExpenseCountryRate": { "required": [ "country_code", "country_name", "full_day_rate", "partial_day_rate" ], "properties": { "id": { "title": "Primary key of the travel expense country rate.", "description": "Internal ID.", "type": "integer" }, "country_code": { "title": "ISO 3166-1 alpha-2 country code (e.g., DE, AT, FR, US)", "type": "string", "maxLength": 2, "minLength": 2 }, "country_name": { "title": "Country name for display", "type": "string" }, "full_day_rate": { "title": "Per diem rate for full day (24 hours)", "type": "string", "minimum": 0 }, "partial_day_rate": { "title": "Per diem rate for partial day (>8h or arrival\/departure)", "type": "string", "minimum": 0 }, "accommodation_rate": { "title": "Optional accommodation rate limit (Uebernachtungspauschale)", "type": "string" }, "breakfast_deduction": { "title": "Breakfast deduction amount (if applicable for this country)", "type": "string" }, "lunch_deduction": { "title": "Lunch deduction amount", "type": "string" }, "dinner_deduction": { "title": "Dinner deduction amount", "type": "string" }, "currency": { "title": "Currency for the rates (usually EUR)", "type": "string" }, "valid_from": { "title": "Date from which this rate is valid", "type": "string", "format": "date-time" }, "valid_until": { "title": "Date until which this rate is valid (null = indefinitely)", "type": "string", "format": "date-time" }, "is_active": { "title": "Is this rate active\/available", "type": "boolean" }, "notes": { "title": "Notes about the rate (e.g., source, special rules)", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "TravelExpenseItem": { "required": [ "expense_type", "expense_date" ], "properties": { "id": { "title": "Primary key of the travel expense item.", "description": "Internal ID.", "type": "integer" }, "travel_expense_report": { "title": "Parent travel expense report", "oneOf": [ { "$ref": "#\/components\/schemas\/TravelExpenseReport3" } ] }, "travel_expense_type": { "title": "Reference to configured expense type", "oneOf": [ { "$ref": "#\/components\/schemas\/TravelExpenseType" } ] }, "expense_type": { "title": "Main expense type category", "type": "string", "enum": [ "VERPFLEGUNG", "FAHRTKOSTEN", "UEBERNACHTUNG", "NEBENKOSTEN" ] }, "expense_subtype": { "title": "Sub-type for more specific categorization", "type": "string" }, "expense_date": { "title": "Date of the expense", "type": "string", "format": "date-time" }, "description": { "title": "Description of the expense", "type": "string" }, "net_amount": { "title": "Net amount (Nettobetrag)", "type": "string" }, "tax_amount": { "title": "Tax amount (Steuerbetrag \/ MwSt)", "type": "string" }, "tax_rate": { "title": "Tax rate percentage (e.g., 19, 7, 0)", "type": "string" }, "gross_amount": { "title": "Gross amount (Bruttobetrag)", "type": "string" }, "currency": { "title": "Currency (default EUR)", "type": "string" }, "original_amount": { "title": "Original amount in foreign currency", "type": "string" }, "exchange_rate": { "title": "Exchange rate used for conversion", "type": "string" }, "kilometers": { "title": "Kilometers driven (for KM_PAUSCHALE)", "type": "string" }, "km_rate": { "title": "Rate per kilometer (default 0.30 EUR for car)", "type": "string" }, "vehicle_type": { "title": "Vehicle type for mileage (PKW, Motorrad, etc.)", "type": "string" }, "license_plate": { "title": "License plate (Kennzeichen)", "type": "string" }, "route_description": { "title": "Route description (from-to)", "type": "string" }, "nights_count": { "title": "Number of nights", "type": "integer" }, "breakfast_included": { "title": "Breakfast included in accommodation", "type": "boolean" }, "is_tax_free": { "title": "Is this expense tax-free (steuerfrei)?", "type": "boolean" }, "tax_free_portion": { "title": "Tax-free amount portion", "type": "string" }, "taxable_portion": { "title": "Taxable amount portion", "type": "string" }, "receipt_attachment": { "title": "Receipt attachment reference", "oneOf": [ { "$ref": "#\/components\/schemas\/Attachment10" } ] }, "receipt_number": { "title": "Receipt number\/reference", "type": "string" }, "vendor_name": { "title": "Vendor\/Supplier name", "type": "string" }, "receipt_missing": { "title": "Is receipt required but missing?", "type": "boolean" }, "missing_receipt_reason": { "title": "Reason for missing receipt", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "TravelExpenseReport": { "required": [ "purpose", "travel_start", "travel_end" ], "properties": { "id": { "title": "Primary key of the travel expense report.", "description": "Internal ID.", "type": "integer" }, "report_number": { "title": "Report number (e.g., TER2025-00001)", "type": "string" }, "submitter": { "title": "Person submitting the expense report", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "approver": { "title": "Approver\/Reviewer", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "purpose": { "title": "Travel purpose\/reason", "type": "string" }, "destination": { "title": "Travel destination", "type": "string" }, "destination_country": { "title": "Destination country (for international per diem rates)", "type": "string" }, "travel_start": { "title": "Travel start date\/time", "type": "string", "format": "date-time" }, "travel_end": { "title": "Travel end date\/time", "type": "string", "format": "date-time" }, "status": { "title": "Status", "type": "string", "enum": [ "DRAFT", "SUBMITTED", "IN_REVIEW", "APPROVED", "REJECTED", "PAID", "CANCELLED" ] }, "status_updated": { "title": "Date when status was last updated", "type": "string", "format": "date-time" }, "submitted_at": { "title": "Submission date", "type": "string", "format": "date-time" }, "approved_at": { "title": "Approval date", "type": "string", "format": "date-time" }, "paid_at": { "title": "Payment date", "type": "string", "format": "date-time" }, "total_per_diem": { "title": "Total Verpflegungsmehraufwand (per diem)", "type": "string" }, "total_travel_costs": { "title": "Total Fahrtkosten (travel costs)", "type": "string" }, "total_accommodation": { "title": "Total Uebernachtungskosten (accommodation)", "type": "string" }, "total_incidentals": { "title": "Total Nebenkosten (incidental expenses)", "type": "string" }, "total_amount": { "title": "Grand total (all expenses)", "type": "string" }, "tax_free_amount": { "title": "Tax-free portion (steuerfreier Anteil)", "type": "string" }, "taxable_amount": { "title": "Taxable portion (steuerpflichtiger Anteil)", "type": "string" }, "currency": { "title": "Currency", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "TravelExpenseReport2": { "properties": {}, "type": "object" }, "TravelExpenseReport3": { "required": [ "purpose", "travel_start", "travel_end" ], "properties": { "id": { "title": "Primary key of the travel expense report.", "description": "Internal ID.", "type": "integer" }, "report_number": { "title": "Report number (e.g., TER2025-00001)", "type": "string" }, "submitter": { "title": "Person submitting the expense report", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "submitter_user": { "title": "User account of submitter", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "approver": { "title": "Approver\/Reviewer", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "company": { "title": "Company\/Employer for billing", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany" } ] }, "project": { "title": "Related project (optional)", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMProject16" } ] }, "invoice": { "title": "Reference to created Invoice (for payment)", "oneOf": [ { "$ref": "#\/components\/schemas\/Invoice30" } ] }, "purpose": { "title": "Travel purpose\/reason", "type": "string" }, "destination": { "title": "Travel destination", "type": "string" }, "destination_country": { "title": "Destination country (for international per diem rates)", "type": "string" }, "travel_start": { "title": "Travel start date\/time", "type": "string", "format": "date-time" }, "travel_end": { "title": "Travel end date\/time", "type": "string", "format": "date-time" }, "status": { "title": "Status", "type": "string", "enum": [ "DRAFT", "SUBMITTED", "IN_REVIEW", "APPROVED", "REJECTED", "PAID", "CANCELLED" ] }, "previous_status": { "title": "Previous status (for workflow tracking)", "type": "string" }, "status_updated": { "title": "Date when status was last updated", "type": "string", "format": "date-time" }, "submitted_at": { "title": "Submission date", "type": "string", "format": "date-time" }, "approved_at": { "title": "Approval date", "type": "string", "format": "date-time" }, "paid_at": { "title": "Payment date", "type": "string", "format": "date-time" }, "rejection_reason": { "title": "Rejection reason", "type": "string" }, "internal_notes": { "title": "Internal notes", "type": "string" }, "total_per_diem": { "title": "Total Verpflegungsmehraufwand (per diem)", "type": "string" }, "total_travel_costs": { "title": "Total Fahrtkosten (travel costs)", "type": "string" }, "total_accommodation": { "title": "Total Uebernachtungskosten (accommodation)", "type": "string" }, "total_incidentals": { "title": "Total Nebenkosten (incidental expenses)", "type": "string" }, "total_amount": { "title": "Grand total (all expenses)", "type": "string" }, "tax_free_amount": { "title": "Tax-free portion (steuerfreier Anteil)", "type": "string" }, "taxable_amount": { "title": "Taxable portion (steuerpflichtiger Anteil)", "type": "string" }, "currency": { "title": "Currency", "type": "string" }, "full_days_count": { "title": "Number of full days (24h) for per diem", "type": "integer" }, "partial_days_count": { "title": "Number of partial days (arrival\/departure)", "type": "integer" }, "breakfast_provided_count": { "title": "Breakfast provided count (for deduction)", "type": "integer" }, "lunch_provided_count": { "title": "Lunch provided count (for deduction)", "type": "integer" }, "dinner_provided_count": { "title": "Dinner provided count (for deduction)", "type": "integer" }, "meal_deduction_amount": { "title": "Total meal deduction amount", "type": "string" }, "items": { "title": "Expense items", "type": "array", "items": { "$ref": "#\/components\/schemas\/TravelExpenseItem" } }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "TravelExpenseType": { "required": [ "type_key", "name", "category" ], "properties": { "id": { "title": "Primary key of the travel expense type.", "description": "Internal ID.", "type": "integer" }, "type_key": { "title": "Internal type identifier (e.g., KM_PAUSCHALE_PKW, HOTEL)", "type": "string" }, "name": { "title": "Display name", "type": "string" }, "description": { "title": "Description", "type": "string" }, "category": { "title": "Parent expense category", "type": "string", "enum": [ "VERPFLEGUNG", "FAHRTKOSTEN", "UEBERNACHTUNG", "NEBENKOSTEN" ] }, "default_rate": { "title": "Default rate (e.g., km rate 0.30, per diem rate 28.00)", "type": "string" }, "rate_unit": { "title": "Unit for the rate (EUR, EUR\/km, EUR\/Tag, etc.)", "type": "string" }, "is_tax_free_default": { "title": "Is this type tax-free by default (steuerfrei)?", "type": "boolean" }, "receipt_required": { "title": "Is receipt required for this type?", "type": "boolean" }, "max_amount": { "title": "Maximum allowed amount per item (for validation, null = no limit)", "type": "string" }, "is_active": { "title": "Is this type active\/available for selection", "type": "boolean" }, "sort_order": { "title": "Sort order for display", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "TrialPolicy": { "properties": { "id": { "title": "Primary key of the trial policy.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "The trial policy is active.", "type": "boolean" }, "max_sessions": { "title": "Number of trial dates per pass", "type": "integer" }, "scope": { "title": "Scope of the trial policy, for example per event or per bookable.", "type": "string" }, "validity_days": { "title": "Days from the first trial date in which the pass may be used; null = no limit", "type": "integer" }, "price_mode": { "title": "How the price of a trial is calculated, for example free or reduced.", "type": "string" }, "product": { "title": "Product billed for a paid trial (per date or once for the pass)", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem12" } ] }, "audience": { "title": "Audience the trial policy applies to, for example new members.", "type": "string" }, "capacity_mode": { "title": "How the capacity is used for trials.", "type": "string" }, "quota_per_date": { "title": "Trial sign-ups per date with capacity mode own_quota", "type": "integer" }, "hide_when_full": { "title": "Hide events without a free place from people looking for a trial (otherwise shown, not bookable)", "type": "boolean" }, "count_mode": { "title": "How trials are counted, for example per person or per event.", "type": "string" }, "max_open_sessions": { "title": "Future trial dates a person may hold at the same time", "type": "integer" }, "cancel_hours": { "title": "Hours before the start of a date until which a cancellation gives the trial date back", "type": "integer" }, "check_age": { "title": "Check the age limits of the event (minAge \/ maxAge) against the birthday of the person", "type": "boolean" }, "follow_up": { "title": "What happens after a trial, for example a sign-up offer.", "type": "string" }, "follow_up_delay_hours": { "title": "Hours after the end of the last trial date before the follow-up starts", "type": "integer" }, "reminder_days": { "title": "Days after the follow-up mail for one reminder while the person did not convert; null = none", "type": "integer" }, "membership_url": { "title": "Where \"become a member\" leads to; empty = setting event_trial_membership_url", "type": "string" }, "mail_completed_text": { "title": "Short text of the e-mail sent when a trial is completed.", "type": "string" }, "mail_completed_long_text": { "title": "Long text of the e-mail sent when a trial is completed.", "type": "string" }, "hold_mode": { "title": "Hold a course place for the trial person from the first trial date on (none = no reservation)", "type": "string" }, "hold_days": { "title": "Days after the end of the last trial date the held place stays free for the sign-up", "type": "integer" }, "hold_reminder_days": { "title": "Days before the end of the hold for one reminder; null = none", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "TrialPolicy2": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "TrialPolicy3": { "properties": { "id": { "title": "Primary key of the trial policy.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "The trial policy is active.", "type": "boolean" }, "max_sessions": { "title": "Number of trial dates per pass", "type": "integer" }, "scope": { "title": "Scope of the trial policy, for example per event or per bookable.", "type": "string" }, "validity_days": { "title": "Days from the first trial date in which the pass may be used; null = no limit", "type": "integer" }, "price_mode": { "title": "How the price of a trial is calculated, for example free or reduced.", "type": "string" }, "product": { "title": "Product billed for a paid trial (per date or once for the pass)", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem8" } ] }, "audience": { "title": "Audience the trial policy applies to, for example new members.", "type": "string" }, "capacity_mode": { "title": "How the capacity is used for trials.", "type": "string" }, "quota_per_date": { "title": "Trial sign-ups per date with capacity mode own_quota", "type": "integer" }, "hide_when_full": { "title": "Hide events without a free place from people looking for a trial (otherwise shown, not bookable)", "type": "boolean" }, "count_mode": { "title": "How trials are counted, for example per person or per event.", "type": "string" }, "max_open_sessions": { "title": "Future trial dates a person may hold at the same time", "type": "integer" }, "cancel_hours": { "title": "Hours before the start of a date until which a cancellation gives the trial date back", "type": "integer" }, "check_age": { "title": "Check the age limits of the event (minAge \/ maxAge) against the birthday of the person", "type": "boolean" }, "follow_up": { "title": "What happens after a trial, for example a sign-up offer.", "type": "string" }, "follow_up_delay_hours": { "title": "Hours after the end of the last trial date before the follow-up starts", "type": "integer" }, "reminder_days": { "title": "Days after the follow-up mail for one reminder while the person did not convert; null = none", "type": "integer" }, "membership_url": { "title": "Where \"become a member\" leads to; empty = setting event_trial_membership_url", "type": "string" }, "mail_completed_text": { "title": "Short text of the e-mail sent when a trial is completed.", "type": "string" }, "mail_completed_long_text": { "title": "Long text of the e-mail sent when a trial is completed.", "type": "string" }, "hold_mode": { "title": "Hold a course place for the trial person from the first trial date on (none = no reservation)", "type": "string" }, "hold_days": { "title": "Days after the end of the last trial date the held place stays free for the sign-up", "type": "integer" }, "hold_reminder_days": { "title": "Days before the end of the hold for one reminder; null = none", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "TrialPolicy4": { "properties": { "id": { "title": "Primary key of the trial policy.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "The trial policy is active.", "type": "boolean" }, "max_sessions": { "title": "Number of trial dates per pass", "type": "integer" }, "scope": { "title": "Scope of the trial policy, for example per event or per bookable.", "type": "string" }, "validity_days": { "title": "Days from the first trial date in which the pass may be used; null = no limit", "type": "integer" }, "price_mode": { "title": "How the price of a trial is calculated, for example free or reduced.", "type": "string" }, "product": { "title": "Product billed for a paid trial (per date or once for the pass)", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem5" } ] }, "audience": { "title": "Audience the trial policy applies to, for example new members.", "type": "string" }, "capacity_mode": { "title": "How the capacity is used for trials.", "type": "string" }, "quota_per_date": { "title": "Trial sign-ups per date with capacity mode own_quota", "type": "integer" }, "hide_when_full": { "title": "Hide events without a free place from people looking for a trial (otherwise shown, not bookable)", "type": "boolean" }, "count_mode": { "title": "How trials are counted, for example per person or per event.", "type": "string" }, "max_open_sessions": { "title": "Future trial dates a person may hold at the same time", "type": "integer" }, "cancel_hours": { "title": "Hours before the start of a date until which a cancellation gives the trial date back", "type": "integer" }, "check_age": { "title": "Check the age limits of the event (minAge \/ maxAge) against the birthday of the person", "type": "boolean" }, "follow_up": { "title": "What happens after a trial, for example a sign-up offer.", "type": "string" }, "follow_up_delay_hours": { "title": "Hours after the end of the last trial date before the follow-up starts", "type": "integer" }, "reminder_days": { "title": "Days after the follow-up mail for one reminder while the person did not convert; null = none", "type": "integer" }, "membership_url": { "title": "Where \"become a member\" leads to; empty = setting event_trial_membership_url", "type": "string" }, "mail_completed_text": { "title": "Short text of the e-mail sent when a trial is completed.", "type": "string" }, "mail_completed_long_text": { "title": "Long text of the e-mail sent when a trial is completed.", "type": "string" }, "hold_mode": { "title": "Hold a course place for the trial person from the first trial date on (none = no reservation)", "type": "string" }, "hold_days": { "title": "Days after the end of the last trial date the held place stays free for the sign-up", "type": "integer" }, "hold_reminder_days": { "title": "Days before the end of the hold for one reminder; null = none", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "TrialPolicy5": { "properties": { "id": { "title": "Primary key of the trial policy.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "The trial policy is active.", "type": "boolean" }, "max_sessions": { "title": "Number of trial dates per pass", "type": "integer" }, "scope": { "title": "Scope of the trial policy, for example per event or per bookable.", "type": "string" }, "validity_days": { "title": "Days from the first trial date in which the pass may be used; null = no limit", "type": "integer" }, "price_mode": { "title": "How the price of a trial is calculated, for example free or reduced.", "type": "string" }, "product": { "title": "Product billed for a paid trial (per date or once for the pass)", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem24" } ] }, "audience": { "title": "Audience the trial policy applies to, for example new members.", "type": "string" }, "capacity_mode": { "title": "How the capacity is used for trials.", "type": "string" }, "quota_per_date": { "title": "Trial sign-ups per date with capacity mode own_quota", "type": "integer" }, "hide_when_full": { "title": "Hide events without a free place from people looking for a trial (otherwise shown, not bookable)", "type": "boolean" }, "count_mode": { "title": "How trials are counted, for example per person or per event.", "type": "string" }, "max_open_sessions": { "title": "Future trial dates a person may hold at the same time", "type": "integer" }, "cancel_hours": { "title": "Hours before the start of a date until which a cancellation gives the trial date back", "type": "integer" }, "check_age": { "title": "Check the age limits of the event (minAge \/ maxAge) against the birthday of the person", "type": "boolean" }, "follow_up": { "title": "What happens after a trial, for example a sign-up offer.", "type": "string" }, "follow_up_delay_hours": { "title": "Hours after the end of the last trial date before the follow-up starts", "type": "integer" }, "reminder_days": { "title": "Days after the follow-up mail for one reminder while the person did not convert; null = none", "type": "integer" }, "membership_url": { "title": "Where \"become a member\" leads to; empty = setting event_trial_membership_url", "type": "string" }, "mail_completed_text": { "title": "Short text of the e-mail sent when a trial is completed.", "type": "string" }, "mail_completed_long_text": { "title": "Long text of the e-mail sent when a trial is completed.", "type": "string" }, "hold_mode": { "title": "Hold a course place for the trial person from the first trial date on (none = no reservation)", "type": "string" }, "hold_days": { "title": "Days after the end of the last trial date the held place stays free for the sign-up", "type": "integer" }, "hold_reminder_days": { "title": "Days before the end of the hold for one reminder; null = none", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "TrialPolicy6": { "properties": { "id": { "title": "Primary key of the trial policy.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "The trial policy is active.", "type": "boolean" }, "max_sessions": { "title": "Number of trial dates per pass", "type": "integer" }, "scope": { "title": "Scope of the trial policy, for example per event or per bookable.", "type": "string" }, "validity_days": { "title": "Days from the first trial date in which the pass may be used; null = no limit", "type": "integer" }, "price_mode": { "title": "How the price of a trial is calculated, for example free or reduced.", "type": "string" }, "product": { "title": "Product billed for a paid trial (per date or once for the pass)", "oneOf": [ { "$ref": "#\/components\/schemas\/PredefinedBillingItem13" } ] }, "audience": { "title": "Audience the trial policy applies to, for example new members.", "type": "string" }, "capacity_mode": { "title": "How the capacity is used for trials.", "type": "string" }, "quota_per_date": { "title": "Trial sign-ups per date with capacity mode own_quota", "type": "integer" }, "hide_when_full": { "title": "Hide events without a free place from people looking for a trial (otherwise shown, not bookable)", "type": "boolean" }, "count_mode": { "title": "How trials are counted, for example per person or per event.", "type": "string" }, "max_open_sessions": { "title": "Future trial dates a person may hold at the same time", "type": "integer" }, "cancel_hours": { "title": "Hours before the start of a date until which a cancellation gives the trial date back", "type": "integer" }, "check_age": { "title": "Check the age limits of the event (minAge \/ maxAge) against the birthday of the person", "type": "boolean" }, "follow_up": { "title": "What happens after a trial, for example a sign-up offer.", "type": "string" }, "follow_up_delay_hours": { "title": "Hours after the end of the last trial date before the follow-up starts", "type": "integer" }, "reminder_days": { "title": "Days after the follow-up mail for one reminder while the person did not convert; null = none", "type": "integer" }, "membership_url": { "title": "Where \"become a member\" leads to; empty = setting event_trial_membership_url", "type": "string" }, "mail_completed_text": { "title": "Short text of the e-mail sent when a trial is completed.", "type": "string" }, "mail_completed_long_text": { "title": "Long text of the e-mail sent when a trial is completed.", "type": "string" }, "hold_mode": { "title": "Hold a course place for the trial person from the first trial date on (none = no reservation)", "type": "string" }, "hold_days": { "title": "Days after the end of the last trial date the held place stays free for the sign-up", "type": "integer" }, "hold_reminder_days": { "title": "Days before the end of the hold for one reminder; null = none", "type": "integer" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "UnifiedCategory": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory10": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory10" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory10" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory11": { "properties": { "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory12": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory12" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory12" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "atags": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessTag" } }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory13": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory13" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory13" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory15": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory15" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory15" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory16": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory16" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory16" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory17": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory17" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory17" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory18": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory18" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory18" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "import_origin_id": { "title": "ID of the record in the source system of the import.", "type": "string" }, "import_origin_id_alt": { "title": "Alternative ID of the record in the source system of the import.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory22": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory22" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory22" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory23": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory23" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory23" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory24": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory24" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory24" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory25": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory25" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory25" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory26": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory26" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory26" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory27": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory27" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory27" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory28": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory28" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory28" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory3": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "UnifiedCategory30": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory30" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory30" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory32": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory32" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory32" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory34": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory34" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory34" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory36": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory36" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory36" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory37": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory37" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory37" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory38": { "properties": { "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory4": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory4" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory4" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory41": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory41" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory41" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory5": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" } }, "type": "object" }, "UnifiedCategory7": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory7" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory7" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategory8": { "properties": { "id": { "title": "Primary key of the unified category.", "description": "Internal ID.", "type": "integer" }, "category_type": { "title": "Type of the category, for example course or membership.", "type": "string" }, "children": { "title": "Child categories.", "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedCategory8" } }, "parent": { "title": "Parent category.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory8" } ] }, "view_order": { "title": "Sort order of the category in lists.", "type": "integer" }, "is_public": { "title": "The category is shown publicly.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "name": { "title": "Name of the entity.", "type": "string" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" }, "main_phone": { "title": "Main phone number.", "type": "string" }, "main_fax": { "title": "Main fax number.", "type": "string" }, "main_email": { "title": "Main e-mail address.", "type": "string" }, "website": { "title": "Website address.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "short_identifier": { "title": "Short identifier of the entity.", "type": "string" }, "slug_identifier": { "title": "Slug used in URLs of the entity.", "type": "string" }, "image_url": { "title": "URL of the image of the entity.", "type": "string" }, "is_ui_filter": { "title": "This property is used to mark an entity as a filter for the frontend", "type": "boolean" } }, "type": "object" }, "UnifiedCategoryExtension": { "properties": { "id": { "title": "Primary key of the category extension.", "description": "Internal ID.", "type": "integer" }, "unified_category": { "title": "Category the extension belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/UnifiedCategory" } ] }, "trainer_person_list_access": { "title": "Trainers can see the person list of the category.", "type": "boolean" }, "trainer_can_post_social": { "title": "Trainers can post in the social feed of the category.", "type": "boolean" } }, "type": "object" }, "UnifiedCategoryExtension2": { "type": "object" }, "UnifiedTag": { "properties": { "id": { "title": "Primary key of the unified tag.", "description": "Internal ID.", "type": "integer" }, "parents": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "UnifiedTag2": { "properties": { "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "UnifiedTag3": { "properties": { "id": { "title": "Primary key of the unified tag.", "description": "Internal ID.", "type": "integer" }, "parents": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag3" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "UnifiedTag4": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "UnifiedTag5": { "properties": { "id": { "title": "Primary key of the unified tag.", "description": "Internal ID.", "type": "integer" }, "parents": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag5" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "UnifiedTag6": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "UnifiedTag7": { "properties": { "id": { "title": "Primary key of the unified tag.", "description": "Internal ID.", "type": "integer" }, "parents": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag7" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "UnifiedTag8": { "properties": { "id": { "title": "Primary key of the unified tag.", "description": "Internal ID.", "type": "integer" }, "parents": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UnifiedTag8" } }, "name": { "title": "Name of the entity.", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "UnifiedTag9": { "properties": { "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "UpdateUserAccessGroup": { "properties": {}, "type": "object" }, "User": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "user_access_group": { "title": "User access group of the user.", "description": "Defines the rights of the user for all scopes.", "oneOf": [ { "$ref": "#\/components\/schemas\/UserAccessGroup3" } ] }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User14": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User2": { "properties": { "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "user_access_group": { "title": "User access group of the user.", "description": "Defines the rights of the user for all scopes.", "oneOf": [ { "$ref": "#\/components\/schemas\/UserAccessGroup3" } ] } }, "type": "object" }, "User2Factor": { "properties": { "id": { "title": "Primary key of the two-factor entry.", "description": "Internal ID.", "type": "integer" }, "factor_type": { "title": "Type of the second factor, for example TOTP.", "type": "string" }, "shared_secret": { "title": "Shared secret of the second factor.", "description": "Only returned in the factor details (group fa_details).", "type": "string" }, "qr_code_content": { "title": "Content of the QR code used to set up the second factor.", "description": "Only returned during setup.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "User2Factor2": { "properties": { "id": { "title": "Primary key of the two-factor entry.", "description": "Internal ID.", "type": "integer" }, "factor_type": { "title": "Type of the second factor, for example TOTP.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "User4": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "user_access_group": { "title": "User access group of the user.", "description": "Defines the rights of the user for all scopes.", "oneOf": [ { "$ref": "#\/components\/schemas\/UserAccessGroup3" } ] }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "user_frontend_data": { "title": "Saved UI settings and favorites of the user.", "oneOf": [ { "$ref": "#\/components\/schemas\/UserFrontendData" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User42": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson91" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User46": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson93" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User47": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson94" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User48": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson95" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User49": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson96" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User5": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "user_frontend_data": { "title": "Saved UI settings and favorites of the user.", "oneOf": [ { "$ref": "#\/components\/schemas\/UserFrontendData" } ] }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User50": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson97" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User52": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson99" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User53": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson100" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User55": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson102" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User56": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson103" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User57": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson104" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User59": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson106" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User6": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson14" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "User7": { "properties": { "id": { "title": "Primary key of the user.", "description": "Internal ID of the login user.", "type": "integer" }, "name": { "title": "Display name of the user.", "description": "Shown in the UI and in audit entries.", "type": "string" }, "username": { "title": "Login name of the user.", "description": "Must be unique across all users.", "type": "string" }, "email": { "title": "E-mail address of the user.", "description": "Used for login notifications, password resets and as a login alias.", "type": "string" }, "positioningeneral": { "title": "Free text describing the position or role of the user.", "type": "string" }, "crm_person": { "title": "CRM person linked to this login user.", "description": "Connects the login account with the person record.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson15" } ] }, "profile_picture_url": { "title": "URL of the profile picture of the user.", "type": "string" }, "archived": { "title": "Marks the user as archived.", "description": "Archived users are kept for history and are not active.", "type": "boolean" }, "require2fa": { "title": "Two-factor authentication is required for this user.", "type": "boolean" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "UserAccessGroup": { "properties": { "id": { "title": "Primary key of the user access group.", "description": "Internal ID, used as the reference by users and access tokens.", "type": "integer" }, "name": { "title": "Name of the user access group.", "description": "Shown to administrators when they assign users to a group.", "type": "string" }, "super_admin": { "title": "Super admin flag of the group.", "description": "Members of a super admin group have all rights, including the administration of other admin groups.", "type": "boolean" }, "admin": { "title": "Admin flag of the group.", "description": "Members of an admin group can manage users and access rights.", "type": "boolean" }, "user": { "title": "User flag of the group.", "description": "Standard flag for regular members.", "type": "boolean" }, "guest": { "title": "Guest flag of the group.", "description": "Guests get only the rights explicitly granted to them.", "type": "boolean" }, "read_installations": { "title": "Read access to installations (servers, installation settings).", "description": "Grants the matching permission for the scope 'installations' in the access rights check of the API.", "type": "boolean" }, "write_installations": { "title": "Write access to installations (servers, installation settings).", "description": "Grants the matching permission for the scope 'installations' in the access rights check of the API.", "type": "boolean" }, "read_user": { "title": "Read access to users and user access groups.", "description": "Grants the matching permission for the scope 'user' in the access rights check of the API.", "type": "boolean" }, "write_user": { "title": "Write access to users and user access groups.", "description": "Grants the matching permission for the scope 'user' in the access rights check of the API.", "type": "boolean" }, "read_customerprofile": { "title": "Read access to customer profiles (customer app data).", "description": "Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.", "type": "boolean" }, "write_customerprofile": { "title": "Write access to customer profiles (customer app data).", "description": "Grants the matching permission for the scope 'customerprofile' in the access rights check of the API.", "type": "boolean" }, "read_crm": { "title": "Read access to CRM (persons, companies, memberships).", "description": "Grants the matching permission for the scope 'crm' in the access rights check of the API.", "type": "boolean" }, "write_crm": { "title": "Write access to CRM (persons, companies, memberships).", "description": "Grants the matching permission for the scope 'crm' in the access rights check of the API.", "type": "boolean" }, "read_crm_project": { "title": "Read access to CRM projects.", "description": "Grants the matching permission for the scope 'crm_project' in the access rights check of the API.", "type": "boolean" }, "write_crm_project": { "title": "Write access to CRM projects.", "description": "Grants the matching permission for the scope 'crm_project' in the access rights check of the API.", "type": "boolean" }, "read_billing": { "title": "Read access to billing (invoices, payments, direct debit).", "description": "Grants the matching permission for the scope 'billing' in the access rights check of the API.", "type": "boolean" }, "write_billing": { "title": "Write access to billing (invoices, payments, direct debit).", "description": "Grants the matching permission for the scope 'billing' in the access rights check of the API.", "type": "boolean" }, "read_taxaccounting": { "title": "Read access to tax accounting (EUER and balance sheet).", "description": "Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.", "type": "boolean" }, "write_taxaccounting": { "title": "Write access to tax accounting (EUER and balance sheet).", "description": "Grants the matching permission for the scope 'taxaccounting' in the access rights check of the API.", "type": "boolean" }, "read_donations": { "title": "Read access to donations.", "description": "Grants the matching permission for the scope 'donations' in the access rights check of the API.", "type": "boolean" }, "write_donations": { "title": "Write access to donations.", "description": "Grants the matching permission for the scope 'donations' in the access rights check of the API.", "type": "boolean" }, "read_products": { "title": "Read access to products.", "description": "Grants the matching permission for the scope 'products' in the access rights check of the API.", "type": "boolean" }, "write_products": { "title": "Write access to products.", "description": "Grants the matching permission for the scope 'products' in the access rights check of the API.", "type": "boolean" }, "read_ticket": { "title": "Read access to tickets.", "description": "Grants the matching permission for the scope 'ticket' in the access rights check of the API.", "type": "boolean" }, "write_ticket": { "title": "Write access to tickets.", "description": "Grants the matching permission for the scope 'ticket' in the access rights check of the API.", "type": "boolean" }, "write_own_ticket": { "title": "Write access to own tickets only.", "description": "Users can only change tickets assigned to them.", "type": "boolean" }, "read_time": { "title": "Read access to time tracking.", "description": "Grants the matching permission for the scope 'time' in the access rights check of the API.", "type": "boolean" }, "write_time": { "title": "Write access to time tracking.", "description": "Grants the matching permission for the scope 'time' in the access rights check of the API.", "type": "boolean" }, "read_trainer_time": { "title": "Read access to trainer time tracking.", "description": "Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.", "type": "boolean" }, "write_trainer_time": { "title": "Write access to trainer time tracking.", "description": "Grants the matching permission for the scope 'trainer_time' in the access rights check of the API.", "type": "boolean" }, "read_studio_training": { "title": "Read access to studio training.", "description": "Grants the matching permission for the scope 'studio_training' in the access rights check of the API.", "type": "boolean" }, "write_studio_training": { "title": "Write access to studio training.", "description": "Grants the matching permission for the scope 'studio_training' in the access rights check of the API.", "type": "boolean" }, "read_call": { "title": "Read access to calls.", "description": "Grants the matching permission for the scope 'call' in the access rights check of the API.", "type": "boolean" }, "write_call": { "title": "Write access to calls.", "description": "Grants the matching permission for the scope 'call' in the access rights check of the API.", "type": "boolean" }, "read_hr": { "title": "Read access to HR.", "description": "Grants the matching permission for the scope 'hr' in the access rights check of the API.", "type": "boolean" }, "write_hr": { "title": "Write access to HR.", "description": "Grants the matching permission for the scope 'hr' in the access rights check of the API.", "type": "boolean" }, "read_srv": { "title": "Read access to servers and containers.", "description": "Grants the matching permission for the scope 'srv' in the access rights check of the API.", "type": "boolean" }, "write_srv": { "title": "Write access to servers and containers.", "description": "Grants the matching permission for the scope 'srv' in the access rights check of the API.", "type": "boolean" }, "read_domain": { "title": "Read access to domains.", "description": "Grants the matching permission for the scope 'domain' in the access rights check of the API.", "type": "boolean" }, "write_domain": { "title": "Write access to domains.", "description": "Grants the matching permission for the scope 'domain' in the access rights check of the API.", "type": "boolean" }, "read_software": { "title": "Read access to software and licenses.", "description": "Grants the matching permission for the scope 'software' in the access rights check of the API.", "type": "boolean" }, "write_software": { "title": "Write access to software and licenses.", "description": "Grants the matching permission for the scope 'software' in the access rights check of the API.", "type": "boolean" }, "read_privacy": { "title": "Read access to privacy and data protection.", "description": "Grants the matching permission for the scope 'privacy' in the access rights check of the API.", "type": "boolean" }, "write_privacy": { "title": "Write access to privacy and data protection.", "description": "Grants the matching permission for the scope 'privacy' in the access rights check of the API.", "type": "boolean" }, "read_event": { "title": "Read access to events.", "description": "Grants the matching permission for the scope 'event' in the access rights check of the API.", "type": "boolean" }, "write_event": { "title": "Write access to events.", "description": "Grants the matching permission for the scope 'event' in the access rights check of the API.", "type": "boolean" }, "read_event_booking": { "title": "Read access to event bookings.", "description": "Grants the matching permission for the scope 'event_booking' in the access rights check of the API.", "type": "boolean" }, "write_event_booking": { "title": "Write access to event bookings.", "description": "Grants the matching permission for the scope 'event_booking' in the access rights check of the API.", "type": "boolean" }, "read_event_booking_group": { "title": "Read access to event booking groups.", "description": "Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.", "type": "boolean" }, "write_event_booking_group": { "title": "Write access to event booking groups.", "description": "Grants the matching permission for the scope 'event_booking_group' in the access rights check of the API.", "type": "boolean" }, "read_maintenance": { "title": "Read access to maintenance.", "description": "Grants the matching permission for the scope 'maintenance' in the access rights check of the API.", "type": "boolean" }, "write_maintenance": { "title": "Write access to maintenance.", "description": "Grants the matching permission for the scope 'maintenance' in the access rights check of the API.", "type": "boolean" }, "write_event_availability": { "title": "Write access to event availability.", "description": "Grants the write permission for the availability scope 'event_availability'.", "type": "boolean" }, "write_eas": { "title": "Write access to the event attendance scanner.", "description": "Grants the write permission for the scope 'eas'.", "type": "boolean" }, "write_wtes": { "title": "Write access to the work time entry scanner.", "description": "Grants the write permission for the scope 'wtes'.", "type": "boolean" }, "write_stats": { "title": "Write access to statistics.", "description": "Grants the write permission for the statistics scope 'stats'.", "type": "boolean" }, "read_shortlink": { "title": "Read access to short links.", "description": "Grants the matching permission for the scope 'shortlink' in the access rights check of the API.", "type": "boolean" }, "write_shortlink": { "title": "Write access to short links.", "description": "Grants the matching permission for the scope 'shortlink' in the access rights check of the API.", "type": "boolean" }, "read_media": { "title": "Read access to media.", "description": "Grants the matching permission for the scope 'media' in the access rights check of the API.", "type": "boolean" }, "write_media": { "title": "Write access to media.", "description": "Grants the matching permission for the scope 'media' in the access rights check of the API.", "type": "boolean" }, "read_settings": { "title": "Read access to settings.", "description": "Grants the matching permission for the scope 'settings' in the access rights check of the API.", "type": "boolean" }, "write_settings": { "title": "Write access to settings.", "description": "Grants the matching permission for the scope 'settings' in the access rights check of the API.", "type": "boolean" }, "read_dwi": { "title": "Read access to data warehouse import (DWI).", "description": "Grants the matching permission for the scope 'dwi' in the access rights check of the API.", "type": "boolean" }, "write_dwi": { "title": "Write access to data warehouse import (DWI).", "description": "Grants the matching permission for the scope 'dwi' in the access rights check of the API.", "type": "boolean" }, "read_flt": { "title": "Read access to flexible LaTeX templates.", "description": "Grants the matching permission for the scope 'flt' in the access rights check of the API.", "type": "boolean" }, "write_flt": { "title": "Write access to flexible LaTeX templates.", "description": "Grants the matching permission for the scope 'flt' in the access rights check of the API.", "type": "boolean" }, "read_c1": { "title": "Read access to custom area 1.", "description": "Grants the matching permission for the scope 'c1' in the access rights check of the API.", "type": "boolean" }, "write_c1": { "title": "Write access to custom area 1.", "description": "Grants the matching permission for the scope 'c1' in the access rights check of the API.", "type": "boolean" }, "read_ch": { "title": "Read access to change history.", "description": "Grants the read permission for the scope 'ch'.", "type": "boolean" }, "read_si": { "title": "Read access to short information.", "description": "Grants the read permission for the scope 'si'.", "type": "boolean" }, "read_pt": { "title": "Read access to payment transactions.", "description": "Grants the matching permission for the scope 'pt' in the access rights check of the API.", "type": "boolean" }, "write_pt": { "title": "Write access to payment transactions.", "description": "Grants the matching permission for the scope 'pt' in the access rights check of the API.", "type": "boolean" }, "read_loc": { "title": "Read access to locations.", "description": "Grants the matching permission for the scope 'loc' in the access rights check of the API.", "type": "boolean" }, "write_loc": { "title": "Write access to locations.", "description": "Grants the matching permission for the scope 'loc' in the access rights check of the API.", "type": "boolean" }, "read_notify": { "title": "Read access to notifications.", "description": "Grants the matching permission for the scope 'notify' in the access rights check of the API.", "type": "boolean" }, "write_notify": { "title": "Write access to notifications.", "description": "Grants the matching permission for the scope 'notify' in the access rights check of the API.", "type": "boolean" }, "read_chat": { "title": "Read access to chat.", "description": "Grants the matching permission for the scope 'chat' in the access rights check of the API.", "type": "boolean" }, "write_chat": { "title": "Write access to chat.", "description": "Grants the matching permission for the scope 'chat' in the access rights check of the API.", "type": "boolean" }, "write_webhook": { "title": "Write access to webhooks.", "description": "Grants the write permission for the scope 'webhook'.", "type": "boolean" }, "read_social": { "title": "Read access to social feed.", "description": "Grants the matching permission for the scope 'social' in the access rights check of the API.", "type": "boolean" }, "write_social": { "title": "Write access to social feed.", "description": "Grants the matching permission for the scope 'social' in the access rights check of the API.", "type": "boolean" }, "read_feedback": { "title": "Read access to feedback.", "description": "Grants the matching permission for the scope 'feedback' in the access rights check of the API.", "type": "boolean" }, "write_feedback": { "title": "Write access to feedback.", "description": "Grants the matching permission for the scope 'feedback' in the access rights check of the API.", "type": "boolean" }, "read_attachment": { "title": "Read access to attachments.", "description": "Grants the matching permission for the scope 'attachment' in the access rights check of the API.", "type": "boolean" }, "write_attachment": { "title": "Write access to attachments.", "description": "Grants the matching permission for the scope 'attachment' in the access rights check of the API.", "type": "boolean" } }, "type": "object" }, "UserAccessGroup3": { "type": "object" }, "UserFrontendData": { "properties": { "id": { "title": "Primary key of the frontend data record.", "description": "Internal ID.", "type": "integer" } }, "type": "object" }, "UserNotification": { "properties": { "id": { "title": "Primary key of the notification.", "description": "Internal ID.", "type": "integer" }, "read": { "title": "Whether the notification has been read.", "type": "boolean" }, "category_identifier": { "title": "Identifier of the notification category.", "type": "string" }, "object_identifier": { "title": "Identifier of the object the notification refers to.", "type": "string" }, "notification_type": { "title": "Type of the notification.", "type": "string" }, "text_identifier": { "title": "Identifier of the notification text template.", "type": "string" }, "long_text_identifier": { "title": "Identifier of the long text template.", "type": "string" }, "html_text": { "title": "HTML text of the notification.", "type": "string" }, "attachments": { "title": "Attachments of the notification.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Attachment10" } }, "only_admin": { "title": "Whether the notification is only shown to administrators.", "type": "boolean" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" }, "address": { "title": "Address as text.", "type": "string" }, "address_street": { "title": "Street of the address.", "type": "string" }, "address_house_number": { "title": "House number of the address.", "type": "string" }, "address_street_level": { "title": "Street and house number of the address.", "type": "string" }, "address_co": { "title": "Care-of line of the address.", "type": "string" }, "address_city": { "title": "City of the address.", "type": "string" }, "address_zip": { "title": "Postal code of the address.", "type": "string" }, "address_admin_level1": { "title": "First administrative level of the address, e.g. the federal state.", "type": "string" }, "address_country": { "title": "Country code of the address.", "type": "string" }, "address_full_country": { "title": "Full name of the country of the address.", "type": "string" }, "address_geo_lat": { "title": "Latitude of the address.", "type": "string" }, "address_geo_lng": { "title": "Longitude of the address.", "type": "string" }, "address_external_provider_id": { "title": "field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE", "type": "string" } }, "type": "object" }, "VacationCarryOverApproval": { "properties": { "id": { "title": "Primary key of the vacation carry-over approval.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the carried-over vacation belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "year": { "title": "The year the days come from - an approval for 2026 keeps days alive into 2027.", "type": "integer" }, "max_days": { "title": "How many days may travel. null means everything that is left, which is what an\nunconditional approval says.", "type": "number", "format": "float" }, "approved": { "title": "Approvals are entered by the people who may grant them, so a record exists because\nsomebody decided - but a record that is prepared and not decided yet must not carry\nanything over, hence the explicit flag.", "type": "boolean" }, "approved_by_user": { "title": "Login user who approved the carry-over.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "approved_at": { "title": "Time the carry-over was approved.", "type": "string", "format": "date-time" }, "status": { "title": "U06: the written flow. REQUESTED while the management has not decided; a record HR\nenters directly is APPROVED or DECLINED at once. null on legacy rows = derived from\nthe approved flag.", "type": "string" }, "requested_days": { "title": "U06: how many days the employee asked to carry over; null = everything that is left.", "type": "number", "format": "float" }, "reason": { "title": "U06: why the days could not be taken (the written request).", "type": "string" }, "requested_by_user": { "title": "Login user who requested the carry-over.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "requested_at": { "title": "Time the carry-over was requested.", "type": "string", "format": "date-time" }, "decision_comment": { "title": "U06: the written decision of the management - mandatory for both outcomes.", "type": "string" }, "decided_by_user": { "title": "Login user who decided on the carry-over.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "decided_at": { "title": "Time the carry-over was decided.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "VacationCarryOverApproval2": { "properties": { "year": { "title": "The year the days come from - an approval for 2026 keeps days alive into 2027.", "type": "integer" }, "max_days": { "title": "How many days may travel. null means everything that is left, which is what an\nunconditional approval says.", "type": "number", "format": "float" }, "approved": { "title": "Approvals are entered by the people who may grant them, so a record exists because\nsomebody decided - but a record that is prepared and not decided yet must not carry\nanything over, hence the explicit flag.", "type": "boolean" }, "requested_days": { "title": "U06: how many days the employee asked to carry over; null = everything that is left.", "type": "number", "format": "float" }, "reason": { "title": "U06: why the days could not be taken (the written request).", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "VacationCarryOverApproval3": { "properties": { "id": { "title": "Primary key of the vacation carry-over approval.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person the carried-over vacation belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "year": { "title": "The year the days come from - an approval for 2026 keeps days alive into 2027.", "type": "integer" }, "max_days": { "title": "How many days may travel. null means everything that is left, which is what an\nunconditional approval says.", "type": "number", "format": "float" }, "approved": { "title": "Approvals are entered by the people who may grant them, so a record exists because\nsomebody decided - but a record that is prepared and not decided yet must not carry\nanything over, hence the explicit flag.", "type": "boolean" }, "approved_by_user": { "title": "Login user who approved the carry-over.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "approved_at": { "title": "Time the carry-over was approved.", "type": "string", "format": "date-time" }, "status": { "title": "U06: the written flow. REQUESTED while the management has not decided; a record HR\nenters directly is APPROVED or DECLINED at once. null on legacy rows = derived from\nthe approved flag.", "type": "string" }, "requested_days": { "title": "U06: how many days the employee asked to carry over; null = everything that is left.", "type": "number", "format": "float" }, "reason": { "title": "U06: why the days could not be taken (the written request).", "type": "string" }, "requested_by_user": { "title": "Login user who requested the carry-over.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "requested_at": { "title": "Time the carry-over was requested.", "type": "string", "format": "date-time" }, "decision_comment": { "title": "U06: the written decision of the management - mandatory for both outcomes.", "type": "string" }, "decided_by_user": { "title": "Login user who decided on the carry-over.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "decided_at": { "title": "Time the carry-over was decided.", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "VacationCarryOverApproval4": { "properties": { "year": { "title": "The year the days come from - an approval for 2026 keeps days alive into 2027.", "type": "integer" }, "max_days": { "title": "How many days may travel. null means everything that is left, which is what an\nunconditional approval says.", "type": "number", "format": "float" }, "approved": { "title": "Approvals are entered by the people who may grant them, so a record exists because\nsomebody decided - but a record that is prepared and not decided yet must not carry\nanything over, hence the explicit flag.", "type": "boolean" }, "requested_days": { "title": "U06: how many days the employee asked to carry over; null = everything that is left.", "type": "number", "format": "float" }, "reason": { "title": "U06: why the days could not be taken (the written request).", "type": "string" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" } }, "type": "object" }, "VacationExpiryNotice": { "properties": { "id": { "title": "Primary key of the vacation expiry notice.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Person who was notified.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "year": { "title": "Kalenderjahr des Hinweises - er entscheidet \u00fcber den Verfall des Resturlaubs aus dem\nVorjahr in diesem Jahr.", "type": "integer" }, "last_year_days": { "title": "Resturlaub aus dem Vorjahr, als der Hinweis erstellt wurde.", "type": "number", "format": "float" }, "current_year_days": { "title": "Offener Urlaub des Jahres (Stand Jahresende), als der Hinweis erstellt wurde.", "type": "number", "format": "float" }, "expires_on": { "title": "Tag, an dem der Resturlaub aus dem Vorjahr verf\u00e4llt (Ende des Verfallmonats).", "type": "string", "format": "date-time" }, "sent_at": { "title": "Time the notice was sent.", "type": "string", "format": "date-time" }, "read_at": { "title": "Lesebest\u00e4tigung der Person (oder von HR erfasst, z. B. f\u00fcr einen Hinweis auf Papier).", "type": "string", "format": "date-time" }, "read_by_user": { "title": "Login user who read the notice.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "VacationExpiryNotice2": { "properties": { "year": { "title": "Kalenderjahr des Hinweises - er entscheidet \u00fcber den Verfall des Resturlaubs aus dem\nVorjahr in diesem Jahr.", "type": "integer" }, "last_year_days": { "title": "Resturlaub aus dem Vorjahr, als der Hinweis erstellt wurde.", "type": "number", "format": "float" }, "current_year_days": { "title": "Offener Urlaub des Jahres (Stand Jahresende), als der Hinweis erstellt wurde.", "type": "number", "format": "float" }, "expires_on": { "title": "Tag, an dem der Resturlaub aus dem Vorjahr verf\u00e4llt (Ende des Verfallmonats).", "type": "string", "format": "date-time" }, "sent_at": { "title": "Time the notice was sent.", "type": "string", "format": "date-time" }, "read_at": { "title": "Lesebest\u00e4tigung der Person (oder von HR erfasst, z. B. f\u00fcr einen Hinweis auf Papier).", "type": "string", "format": "date-time" }, "deleted": { "title": "This property is used to mark an entity as deleted \/ archived", "type": "boolean" }, "name": { "title": "Name of the entity.", "type": "string" } }, "type": "object" }, "VolunteerHourEntry": { "properties": { "shift_assignment_id": { "type": "integer" }, "settlement_id": { "type": "integer" }, "is_settled": { "type": "boolean" }, "approved_by_name": { "type": "string" }, "id": { "title": "Primary key of the volunteer hour entry.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Volunteer who worked the hours.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson27" } ] }, "work_date": { "title": "Day the work was done.", "type": "string", "format": "date-time" }, "duration_minutes": { "title": "Duration of the work in minutes.", "type": "integer" }, "description": { "title": "Description of the work.", "type": "string" }, "status": { "title": "Status of the entry, for example pending, approved or rejected.", "type": "string" }, "rejection_reason": { "title": "Reason the entry was rejected.", "type": "string" }, "event": { "title": "Event the hours were worked for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent10" } ] }, "approved_at": { "title": "Time the entry was approved.", "type": "string", "format": "date-time" }, "created": { "title": "Time the entry was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Time the entry was last changed.", "type": "string", "format": "date-time" } }, "type": "object" }, "VolunteerHourEntry2": { "properties": { "person": { "title": "Volunteer who worked the hours.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson33" } ] }, "work_date": { "title": "Day the work was done.", "type": "string", "format": "date-time" }, "duration_minutes": { "title": "Duration of the work in minutes.", "type": "integer" }, "description": { "title": "Description of the work.", "type": "string" }, "event": { "title": "Event the hours were worked for.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent11" } ] } }, "type": "object" }, "VolunteerHourRequirement": { "properties": { "id": { "title": "Primary key of the volunteer hour requirement.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Volunteer the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson27" } ] }, "company": { "title": "Company the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany24" } ] }, "valid_from": { "title": "Start of the requirement.", "type": "string", "format": "date-time" }, "valid_until": { "title": "End of the requirement.", "type": "string", "format": "date-time" }, "exempt": { "title": "The volunteer is exempt from the requirement.", "type": "boolean" }, "required_hours": { "title": "Hours per period instead of the installation wide value. null = installation wide value.", "type": "number", "format": "float" }, "reason": { "title": "Reason for the requirement or exemption.", "type": "string" }, "created": { "title": "Time the requirement was created.", "type": "string", "format": "date-time" } }, "type": "object" }, "VolunteerHourRequirement2": { "properties": { "person": { "title": "Volunteer the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson35" } ] }, "company": { "title": "Company the requirement applies to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany25" } ] }, "valid_from": { "title": "Start of the requirement.", "type": "string", "format": "date-time" }, "valid_until": { "title": "End of the requirement.", "type": "string", "format": "date-time" }, "exempt": { "title": "The volunteer is exempt from the requirement.", "type": "boolean" }, "required_hours": { "title": "Hours per period instead of the installation wide value. null = installation wide value.", "type": "number", "format": "float" }, "reason": { "title": "Reason for the requirement or exemption.", "type": "string" } }, "type": "object" }, "VolunteerHourSettlement": { "properties": { "subject_name": { "title": "Display name of the settled member or billing account.", "type": "string" }, "id": { "title": "Primary key of the volunteer hour settlement.", "description": "Internal ID.", "type": "integer" }, "person": { "title": "Set when the hours are owed per member.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson27" } ] }, "company": { "title": "Billing account the compensation is charged to. When the hours are owed per account\n(household), the settlement belongs to the account only and person stays empty.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMCompany24" } ] }, "obligation_scope": { "title": "Scope of the volunteer obligation, for example year or month.", "type": "string" }, "period_start": { "title": "Start of the settled period.", "type": "string", "format": "date-time" }, "period_end": { "title": "End of the settled period.", "type": "string", "format": "date-time" }, "required_minutes": { "title": "Minutes the volunteer had to work.", "type": "integer" }, "credited_minutes": { "title": "Minutes the volunteer worked and got credited.", "type": "integer" }, "carried_in_minutes": { "title": "Minutes carried in from the previous period.", "type": "integer" }, "missing_minutes": { "title": "Minutes missing to the obligation.", "type": "integer" }, "surplus_minutes": { "title": "Minutes worked above the obligation.", "type": "integer" }, "carried_out_minutes": { "title": "Surplus taken into the next period.", "type": "integer" }, "compensation_rate": { "title": "Compensation per missing hour in force when the settlement was generated (frozen).", "type": "number", "format": "float" }, "compensation_amount": { "title": "Amount paid as compensation for the missing minutes.", "type": "number", "format": "float" }, "compensation_capped": { "title": "The compensation was reduced to the configured maximum.", "type": "boolean" }, "status": { "title": "Status of the settlement, for example open or settled.", "type": "string" }, "note": { "title": "Note on the settlement.", "type": "string" }, "generation_date": { "title": "Time the settlement was generated.", "type": "string", "format": "date-time" } }, "type": "object" }, "VolunteerShift": { "properties": { "effective_credited_minutes": { "title": "Minutes an attended helper is credited with.", "type": "integer" }, "signed_up_count": { "title": "Helpers that are signed up or attended - cancelled sign-ups free their slot again.", "type": "integer" }, "open_slots": { "title": "Free slots, null when the shift has no limit.", "type": "integer" }, "id": { "title": "Primary key of the volunteer shift.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the volunteer shift.", "type": "string" }, "description": { "title": "Description of the volunteer shift.", "type": "string" }, "location": { "title": "Place where the volunteer shift takes place.", "type": "string" }, "start": { "title": "Start of the volunteer shift.", "type": "string", "format": "date-time" }, "end": { "title": "End of the volunteer shift.", "type": "string", "format": "date-time" }, "required_helpers": { "title": "Helpers needed. 0 = no limit.", "type": "integer" }, "credited_minutes": { "title": "Minutes credited per attended helper. null = the length of the shift.", "type": "integer" }, "signup_until": { "title": "Sign-up closes at this point in time. null = until the shift starts.", "type": "string", "format": "date-time" }, "event": { "title": "Event the volunteer shift belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent10" } ] }, "deleted": { "title": "The volunteer shift is deleted.", "type": "boolean" }, "created": { "title": "Time the volunteer shift was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Time the volunteer shift was last changed.", "type": "string", "format": "date-time" } }, "type": "object" }, "VolunteerShift2": { "properties": { "name": { "title": "Name of the volunteer shift.", "type": "string" }, "description": { "title": "Description of the volunteer shift.", "type": "string" }, "location": { "title": "Place where the volunteer shift takes place.", "type": "string" }, "start": { "title": "Start of the volunteer shift.", "type": "string", "format": "date-time" }, "end": { "title": "End of the volunteer shift.", "type": "string", "format": "date-time" }, "required_helpers": { "title": "Helpers needed. 0 = no limit.", "type": "integer" }, "credited_minutes": { "title": "Minutes credited per attended helper. null = the length of the shift.", "type": "integer" }, "signup_until": { "title": "Sign-up closes at this point in time. null = until the shift starts.", "type": "string", "format": "date-time" }, "event": { "title": "Event the volunteer shift belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent12" } ] }, "deleted": { "title": "The volunteer shift is deleted.", "type": "boolean" } }, "type": "object" }, "VolunteerShift3": { "properties": { "effective_credited_minutes": { "title": "Minutes an attended helper is credited with.", "type": "integer" }, "signed_up_count": { "title": "Helpers that are signed up or attended - cancelled sign-ups free their slot again.", "type": "integer" }, "open_slots": { "title": "Free slots, null when the shift has no limit.", "type": "integer" }, "id": { "title": "Primary key of the volunteer shift.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the volunteer shift.", "type": "string" }, "description": { "title": "Description of the volunteer shift.", "type": "string" }, "location": { "title": "Place where the volunteer shift takes place.", "type": "string" }, "start": { "title": "Start of the volunteer shift.", "type": "string", "format": "date-time" }, "end": { "title": "End of the volunteer shift.", "type": "string", "format": "date-time" }, "required_helpers": { "title": "Helpers needed. 0 = no limit.", "type": "integer" }, "credited_minutes": { "title": "Minutes credited per attended helper. null = the length of the shift.", "type": "integer" }, "signup_until": { "title": "Sign-up closes at this point in time. null = until the shift starts.", "type": "string", "format": "date-time" }, "event": { "title": "Event the volunteer shift belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/BaseEvent25" } ] }, "deleted": { "title": "The volunteer shift is deleted.", "type": "boolean" }, "created": { "title": "Time the volunteer shift was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Time the volunteer shift was last changed.", "type": "string", "format": "date-time" } }, "type": "object" }, "VolunteerShift4": { "type": "object" }, "VolunteerShiftAssignment": { "properties": { "hour_entry_id": { "type": "integer" }, "id": { "title": "Primary key of the volunteer shift assignment.", "description": "Internal ID.", "type": "integer" }, "shift": { "title": "Volunteer shift the assignment belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/VolunteerShift3" } ] }, "person": { "title": "Person assigned to the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson27" } ] }, "status": { "title": "Status of the assignment, for example assigned or cancelled.", "type": "string" }, "note": { "title": "Note on the assignment.", "type": "string" }, "cancelled_at": { "title": "Time the assignment was cancelled.", "type": "string", "format": "date-time" }, "created": { "title": "Time the assignment was created.", "type": "string", "format": "date-time" } }, "type": "object" }, "VolunteerShiftAssignment2": { "properties": { "shift": { "title": "Volunteer shift the assignment belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/VolunteerShift4" } ] }, "person": { "title": "Person assigned to the shift.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson34" } ] }, "status": { "title": "Status of the assignment, for example assigned or cancelled.", "type": "string" }, "note": { "title": "Note on the assignment.", "type": "string" } }, "type": "object" }, "WPInstallation": { "properties": { "id": { "title": "Primary key of the WordPress installation.", "description": "Internal ID.", "type": "integer" }, "name": { "title": "Name of the WordPress installation.", "type": "string" }, "siteurl": { "title": "URL of the WordPress site.", "type": "string" }, "wpversion": { "title": "Version of WordPress.", "type": "string" }, "phpversion": { "title": "Version of PHP on the site.", "type": "string" }, "system": { "title": "Operating system of the server.", "type": "string" }, "iw_version": { "title": "Version of the inwendo plugin.", "type": "string" }, "maxphpexecutiontime": { "title": "Maximum PHP execution time.", "type": "string" }, "active": { "title": "Whether the installation is active.", "type": "boolean" }, "adminconfirmed": { "title": "Whether an administrator has confirmed the installation.", "type": "boolean" }, "lastupdate": { "title": "Point in time of the last update from the installation.", "type": "string", "format": "date-time" }, "configuration": { "title": "Configuration of the installation.", "oneOf": [ { "$ref": "#\/components\/schemas\/InstallationConfig" } ] }, "companies": { "title": "Companies linked to the installation.", "type": "array", "items": { "$ref": "#\/components\/schemas\/CRMCompany4" } }, "itype": { "title": "Installation type.", "type": "string" }, "environment": { "title": "Environment of the installation, e.g. production or test.", "type": "string" }, "host_name": { "title": "Host name of the server.", "type": "string" }, "internal_status_code": { "title": "Status code used internally.", "type": "string" }, "public_status_message": { "title": "Status message shown publicly.", "type": "string" }, "public_listing": { "title": "Whether the installation is listed publicly.", "type": "boolean" }, "public_listing_key1": { "title": "First key for the public listing.", "type": "string" }, "public_listing_key2": { "title": "Second key for the public listing.", "type": "string" }, "public_listing_name": { "title": "Name shown in the public listing.", "type": "string" }, "public_listing_image": { "title": "Image shown in the public listing.", "type": "string" }, "public_listing_own_customer_ui": { "title": "Whether the listing links to its own customer UI.", "type": "boolean" }, "public_listing_own_backend_ui": { "title": "Whether the listing links to its own backend UI.", "type": "boolean" }, "frontend_host": { "title": "Host name of the frontend.", "type": "string" }, "allowed_sender_mail": { "title": "E-mail address allowed to send mail for the installation.", "type": "string" }, "usage_mode": { "title": "Usage mode of the installation.", "type": "string" }, "usage_license": { "title": "License of the installation.", "type": "integer" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "WebhookLog": { "properties": { "webhook": { "title": "Webhook the entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/RegisteredWebhook3" } ] }, "run_identifier": { "title": "Groups all rows that belong to one dispatch of one webhook, so the UI\ncan fold request and response into a single entry.", "type": "string" }, "level": { "title": "Log level of the entry.", "type": "string" }, "step": { "title": "Step of the webhook processing.", "type": "string" }, "notification_type": { "title": "Type of the notification that triggered the webhook.", "type": "string" }, "reference_class_name": { "title": "Class name of the record the webhook refers to.", "type": "string" }, "reference_id": { "title": "ID of the record the webhook refers to.", "type": "string" }, "database_action": { "title": "Database action that triggered the webhook.", "type": "string" }, "target": { "title": "Redacted target of the call \u2014 URL, MQTT topic, file path.", "type": "string" }, "request_method": { "title": "HTTP method of the request.", "type": "string" }, "response_code": { "title": "HTTP response code.", "type": "integer" }, "duration_ms": { "title": "Duration of the request in milliseconds.", "type": "integer" }, "request_body": { "title": "Body of the request.", "type": "string" }, "response_body": { "title": "Body of the response.", "type": "string" }, "message": { "title": "Message of the log entry.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "WorkTimeEntry": { "properties": { "id": { "title": "Primary key of the work time entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user who worked.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Description of the work.", "type": "string" }, "start": { "title": "Start of the work time.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the work time as text.", "type": "string" }, "start_month": { "title": "Month of the start.", "type": "integer" }, "start_year": { "title": "Year of the start.", "type": "integer" }, "end": { "title": "End of the work time.", "type": "string", "format": "date-time" }, "break_start": { "title": "Start of the break.", "type": "string", "format": "date-time" }, "break_end": { "title": "End of the break.", "type": "string", "format": "date-time" }, "break_duration": { "title": "duration of break in seconds", "type": "integer" }, "manual_break_duration": { "title": "Z17.2: Pausendauer in Sekunden ohne Lage, z. B. aus einer genehmigten Korrektur, die nur\ndie Dauer der Pause \u00e4ndert. Z\u00e4hlt wie eine erfasste Pause, solange keine Pause mit Beginn\nund Ende erfasst ist; null = keine.", "type": "integer" }, "auto_break": { "title": "A break was added automatically.", "type": "boolean" }, "force_no_break": { "title": "No break is added for this entry.", "type": "boolean" }, "duration": { "title": "duration in seconds", "type": "integer" }, "auto_closed": { "title": "The entry was closed automatically.", "type": "boolean" }, "has_warning": { "title": "The entry has a warning, for example a missing end.", "type": "boolean" }, "has_scanner_start": { "title": "The start was recorded with the scanner.", "type": "boolean" }, "has_scanner_end": { "title": "The end was recorded with the scanner.", "type": "boolean" }, "closed_editing": { "title": "Editing of the entry is closed.", "type": "boolean" }, "closed_editing_hr": { "title": "Editing of the entry is closed for HR.", "type": "boolean" }, "confirmed": { "title": "The entry is confirmed.", "type": "boolean" }, "shift_plan_entry": { "title": "L38: the shift this entry was clocked for. The entry keeps the real clock times;\nthe link only says which planned shift they belong to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftPlanEntry3" } ] }, "shift_start_deviation_minutes": { "title": "L38: minutes the real start lies before (negative) or after (positive) the planned\nshift start; null without a shift.", "type": "integer" }, "shift_end_deviation_minutes": { "title": "L38: minutes the real end lies before (negative) or after (positive) the planned shift end.", "type": "integer" }, "content_type": { "title": "Type of the work, for example work or training.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "WorkTimeEntry2": { "properties": { "person": { "title": "Person who worked.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson36" } ] }, "contract": { "title": "Contract the work time is booked on.", "oneOf": [ { "$ref": "#\/components\/schemas\/EmploymentContract7" } ] }, "description": { "title": "Description of the work.", "type": "string" }, "start": { "title": "Start of the work time.", "type": "string", "format": "date-time" }, "end": { "title": "End of the work time.", "type": "string", "format": "date-time" }, "break_start": { "title": "Start of the break.", "type": "string", "format": "date-time" }, "break_end": { "title": "End of the break.", "type": "string", "format": "date-time" }, "force_no_break": { "title": "No break is added for this entry.", "type": "boolean" }, "content_type": { "title": "Type of the work, for example work or training.", "type": "string" } }, "type": "object" }, "WorkTimeEntry3": { "properties": { "id": { "title": "Primary key of the work time entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user who worked.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Description of the work.", "type": "string" }, "start": { "title": "Start of the work time.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the work time as text.", "type": "string" }, "start_month": { "title": "Month of the start.", "type": "integer" }, "start_year": { "title": "Year of the start.", "type": "integer" }, "end": { "title": "End of the work time.", "type": "string", "format": "date-time" }, "break_start": { "title": "Start of the break.", "type": "string", "format": "date-time" }, "break_end": { "title": "End of the break.", "type": "string", "format": "date-time" }, "break_duration": { "title": "duration of break in seconds", "type": "integer" }, "manual_break_duration": { "title": "Z17.2: Pausendauer in Sekunden ohne Lage, z. B. aus einer genehmigten Korrektur, die nur\ndie Dauer der Pause \u00e4ndert. Z\u00e4hlt wie eine erfasste Pause, solange keine Pause mit Beginn\nund Ende erfasst ist; null = keine.", "type": "integer" }, "auto_break": { "title": "A break was added automatically.", "type": "boolean" }, "force_no_break": { "title": "No break is added for this entry.", "type": "boolean" }, "duration": { "title": "duration in seconds", "type": "integer" }, "auto_closed": { "title": "The entry was closed automatically.", "type": "boolean" }, "has_warning": { "title": "The entry has a warning, for example a missing end.", "type": "boolean" }, "has_scanner_start": { "title": "The start was recorded with the scanner.", "type": "boolean" }, "has_scanner_end": { "title": "The end was recorded with the scanner.", "type": "boolean" }, "closed_editing": { "title": "Editing of the entry is closed.", "type": "boolean" }, "closed_editing_hr": { "title": "Editing of the entry is closed for HR.", "type": "boolean" }, "confirmed": { "title": "The entry is confirmed.", "type": "boolean" }, "shift_plan_entry": { "title": "L38: the shift this entry was clocked for. The entry keeps the real clock times;\nthe link only says which planned shift they belong to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftPlanEntry6" } ] }, "shift_start_deviation_minutes": { "title": "L38: minutes the real start lies before (negative) or after (positive) the planned\nshift start; null without a shift.", "type": "integer" }, "shift_end_deviation_minutes": { "title": "L38: minutes the real end lies before (negative) or after (positive) the planned shift end.", "type": "integer" }, "content_type": { "title": "Type of the work, for example work or training.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "WorkTimeEntry4": { "type": "object" }, "WorkTimeEntry5": { "properties": { "id": { "title": "Primary key of the work time entry.", "description": "Internal ID.", "type": "integer" }, "user": { "title": "Login user who worked.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "description": { "title": "Description of the work.", "type": "string" }, "start": { "title": "Start of the work time.", "type": "string", "format": "date-time" }, "start_date": { "title": "Start date of the work time as text.", "type": "string" }, "start_month": { "title": "Month of the start.", "type": "integer" }, "start_year": { "title": "Year of the start.", "type": "integer" }, "end": { "title": "End of the work time.", "type": "string", "format": "date-time" }, "break_start": { "title": "Start of the break.", "type": "string", "format": "date-time" }, "break_end": { "title": "End of the break.", "type": "string", "format": "date-time" }, "break_duration": { "title": "duration of break in seconds", "type": "integer" }, "manual_break_duration": { "title": "Z17.2: Pausendauer in Sekunden ohne Lage, z. B. aus einer genehmigten Korrektur, die nur\ndie Dauer der Pause \u00e4ndert. Z\u00e4hlt wie eine erfasste Pause, solange keine Pause mit Beginn\nund Ende erfasst ist; null = keine.", "type": "integer" }, "auto_break": { "title": "A break was added automatically.", "type": "boolean" }, "force_no_break": { "title": "No break is added for this entry.", "type": "boolean" }, "duration": { "title": "duration in seconds", "type": "integer" }, "auto_closed": { "title": "The entry was closed automatically.", "type": "boolean" }, "has_warning": { "title": "The entry has a warning, for example a missing end.", "type": "boolean" }, "has_scanner_start": { "title": "The start was recorded with the scanner.", "type": "boolean" }, "has_scanner_end": { "title": "The end was recorded with the scanner.", "type": "boolean" }, "closed_editing": { "title": "Editing of the entry is closed.", "type": "boolean" }, "closed_editing_hr": { "title": "Editing of the entry is closed for HR.", "type": "boolean" }, "confirmed": { "title": "The entry is confirmed.", "type": "boolean" }, "shift_plan_entry": { "title": "L38: the shift this entry was clocked for. The entry keeps the real clock times;\nthe link only says which planned shift they belong to.", "oneOf": [ { "$ref": "#\/components\/schemas\/ShiftPlanEntry7" } ] }, "shift_start_deviation_minutes": { "title": "L38: minutes the real start lies before (negative) or after (positive) the planned\nshift start; null without a shift.", "type": "integer" }, "shift_end_deviation_minutes": { "title": "L38: minutes the real end lies before (negative) or after (positive) the planned shift end.", "type": "integer" }, "content_type": { "title": "Type of the work, for example work or training.", "type": "string" }, "search_string": { "title": "Text that the entity can be searched by.", "type": "string" } }, "type": "object" }, "WorkTimeEntryCorrectionRequest": { "properties": { "id": { "title": "Primary key of the correction request.", "description": "Internal ID.", "type": "integer" }, "work_time_entry": { "title": "Work time entry to be corrected.", "oneOf": [ { "$ref": "#\/components\/schemas\/WorkTimeEntry3" } ] }, "person": { "title": "Person the work time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "requested_by_user": { "title": "User who requested the correction.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "old_start": { "title": "Start of the work time entry before the correction.", "type": "string", "format": "date-time" }, "old_end": { "title": "End of the work time entry before the correction.", "type": "string", "format": "date-time" }, "old_break_start": { "title": "Start of the break before the correction.", "type": "string", "format": "date-time" }, "old_break_end": { "title": "End of the break before the correction.", "type": "string", "format": "date-time" }, "old_break_duration": { "title": "Duration of the break before the correction.", "type": "integer" }, "new_start": { "title": "Requested new start of the work time entry.", "type": "string", "format": "date-time" }, "new_end": { "title": "Requested new end of the work time entry.", "type": "string", "format": "date-time" }, "new_break_start": { "title": "Requested new start of the break.", "type": "string", "format": "date-time" }, "new_break_end": { "title": "Requested new end of the break.", "type": "string", "format": "date-time" }, "new_break_duration": { "title": "Requested new duration of the break.", "type": "integer" }, "reason": { "title": "Why the entry is wrong (mandatory).", "type": "string" }, "status": { "title": "Status of the correction request.", "type": "string" }, "decided_by_user": { "title": "User who approved or rejected the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "decided_at": { "title": "Point in time of the decision.", "type": "string", "format": "date-time" }, "decision_comment": { "title": "Comment given with the decision.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "WorkTimeEntryCorrectionRequest2": { "properties": { "work_time_entry": { "title": "Work time entry to be corrected.", "oneOf": [ { "$ref": "#\/components\/schemas\/WorkTimeEntry4" } ] }, "new_start": { "title": "Requested new start of the work time entry.", "type": "string", "format": "date-time" }, "new_end": { "title": "Requested new end of the work time entry.", "type": "string", "format": "date-time" }, "new_break_start": { "title": "Requested new start of the break.", "type": "string", "format": "date-time" }, "new_break_end": { "title": "Requested new end of the break.", "type": "string", "format": "date-time" }, "new_break_duration": { "title": "Requested new duration of the break.", "type": "integer" }, "reason": { "title": "Why the entry is wrong (mandatory).", "type": "string" } }, "type": "object" }, "WorkTimeEntryCorrectionRequest3": { "properties": { "id": { "title": "Primary key of the correction request.", "description": "Internal ID.", "type": "integer" }, "work_time_entry": { "title": "Work time entry to be corrected.", "oneOf": [ { "$ref": "#\/components\/schemas\/WorkTimeEntry5" } ] }, "user": { "title": "User the work time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "person": { "title": "Person the work time entry belongs to.", "oneOf": [ { "$ref": "#\/components\/schemas\/CRMPerson10" } ] }, "requested_by_user": { "title": "User who requested the correction.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "old_start": { "title": "Start of the work time entry before the correction.", "type": "string", "format": "date-time" }, "old_end": { "title": "End of the work time entry before the correction.", "type": "string", "format": "date-time" }, "old_break_start": { "title": "Start of the break before the correction.", "type": "string", "format": "date-time" }, "old_break_end": { "title": "End of the break before the correction.", "type": "string", "format": "date-time" }, "old_break_duration": { "title": "Duration of the break before the correction.", "type": "integer" }, "new_start": { "title": "Requested new start of the work time entry.", "type": "string", "format": "date-time" }, "new_end": { "title": "Requested new end of the work time entry.", "type": "string", "format": "date-time" }, "new_break_start": { "title": "Requested new start of the break.", "type": "string", "format": "date-time" }, "new_break_end": { "title": "Requested new end of the break.", "type": "string", "format": "date-time" }, "new_break_duration": { "title": "Requested new duration of the break.", "type": "integer" }, "reason": { "title": "Why the entry is wrong (mandatory).", "type": "string" }, "status": { "title": "Status of the correction request.", "type": "string" }, "decided_by_user": { "title": "User who approved or rejected the request.", "oneOf": [ { "$ref": "#\/components\/schemas\/User14" } ] }, "decided_at": { "title": "Point in time of the decision.", "type": "string", "format": "date-time" }, "decision_comment": { "title": "Comment given with the decision.", "type": "string" }, "created": { "title": "Point in time the entity was created.", "type": "string", "format": "date-time" }, "updated": { "title": "Point in time the entity was last updated.", "type": "string", "format": "date-time" } }, "type": "object" }, "WorkTimeEntryGroupedDate": { "properties": {}, "type": "object" }, "WorkTimeEntryGroupedMonth": { "properties": {}, "type": "object" }, "WpmailConfig": { "properties": { "id": { "title": "Primary key of the mail configuration.", "description": "Internal ID.", "type": "integer" }, "active": { "title": "Whether the mail configuration is active.", "type": "boolean" }, "mail_from": { "title": "E-mail address the mails are sent from.", "type": "string" }, "mail_from_name": { "title": "Sender name of the mails.", "type": "string" }, "mailer": { "title": "Mailer that sends the mails.", "type": "string" }, "mail_set_return_path": { "title": "Whether the return path is set to the sender address.", "type": "string" }, "smtp_host": { "title": "Host name of the SMTP server.", "type": "string" }, "smtp_port": { "title": "Port of the SMTP server.", "type": "string" }, "smtp_ssl": { "title": "Encryption used for the SMTP connection.", "type": "string" }, "smtp_auth": { "title": "Whether the SMTP server requires authentication.", "type": "string" }, "smtp_user": { "title": "User name for the SMTP server.", "type": "string" }, "smtp_pass": { "title": "Password for the SMTP server.", "type": "string" } }, "type": "object" } }, "parameters": { "searchString": { "name": "searchString", "in": "query", "description": "text to search for in the list", "required": false, "schema": { "type": "string" } }, "orderFieldName": { "name": "orderFieldName", "in": "query", "description": "name of the order field", "required": false, "schema": { "type": "string" } }, "orderFieldSort": { "name": "orderFieldSort", "in": "query", "description": "sorting mode", "required": false, "schema": { "type": "string", "enum": [ "DESC", "ASC" ] } }, "page": { "name": "page", "in": "query", "description": "page of the list", "required": false, "schema": { "type": "integer", "default": 0 } }, "pageSize": { "name": "pageSize", "in": "query", "description": "number of entries for each page", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 200, "minimum": 1 } }, "withMaxPageNumber": { "name": "withMaxPageNumber", "in": "query", "description": "returns the number of pages available as a header if this is set", "required": false, "schema": { "type": "string" } }, "iw-build-id": { "name": "iw-build-id", "in": "query", "description": "build id of the client", "required": false, "schema": { "type": "string" } }, "iw-package-id": { "name": "iw-package-id", "in": "query", "description": "package id of the client", "required": false, "schema": { "type": "string" } } }, "securitySchemes": { "sessionToken": { "type": "apiKey", "description": "session_id returned by the Login \/ E-Mail Login API", "name": "x-session-token", "in": "header" }, "jwtTokenInternal": { "type": "apiKey", "description": "jwtTokenInternal returned by the Login \/ JWT Login Token API", "name": "x-iw-jwt-token", "in": "header" }, "loginConfig": { "type": "apiKey", "description": "additional JWT token to configure rate limits, ip check and the length the session token is valid", "name": "x-iw-login-config", "in": "header" } } }, "security": [ { "sessionToken": [] }, { "jwtTokenInternal": [] }, { "loginConfig": [] } ], "tags": [ { "name": "Login \/ E-Mail Login", "description": "Login \/ E-Mail Login" }, { "name": "Login \/ Logout", "description": "Login \/ Logout" }, { "name": "User \/ User", "description": "User \/ User" }, { "name": "User \/ UserAccessGroup", "description": "User \/ UserAccessGroup" }, { "name": "Session \/ Session", "description": "Session \/ Session" }, { "name": "Customer \/ Saldo", "description": "Customer \/ Saldo" }, { "name": "Customer \/ Customerticket", "description": "Customer \/ Customerticket" }, { "name": "Social Login \/ Google Login", "description": "Social Login \/ Google Login" }, { "name": "Attachment \/ Attachment", "description": "Attachment \/ Attachment" }, { "name": "Access \/ AccessTag", "description": "Access \/ AccessTag" }, { "name": "Tool \/ SimpleChange", "description": "Tool \/ SimpleChange" }, { "name": "Login \/ JWT ApiAccess", "description": "Login \/ JWT ApiAccess" }, { "name": "User \/ User2Factor", "description": "User \/ User2Factor" }, { "name": "Login \/ Self Sign Up", "description": "Login \/ Self Sign Up" }, { "name": "Customer \/ BaseDataSelfService", "description": "Customer \/ BaseDataSelfService" }, { "name": "Customer \/ Self Sign Up Code", "description": "Customer \/ Self Sign Up Code" }, { "name": "CustomerPanel \/ Self-Service \/ MembershipPause", "description": "CustomerPanel \/ Self-Service \/ MembershipPause" }, { "name": "CustomerPanel \/ Self-Service \/ Donations", "description": "CustomerPanel \/ Self-Service \/ Donations" }, { "name": "Customer \/ SelfServiceMembership", "description": "Customer \/ SelfServiceMembership" }, { "name": "Public \/ Session", "description": "Public \/ Session" }, { "name": "Public \/ SupportChat", "description": "Public \/ SupportChat" }, { "name": "Chat \/ TrainerChatroom", "description": "Chat \/ TrainerChatroom" }, { "name": "Chat \/ CustomerChatbotConsent", "description": "Chat \/ CustomerChatbotConsent" }, { "name": "CustomerPanel \/ CustomerAppUsage", "description": "CustomerPanel \/ CustomerAppUsage" }, { "name": "Chat \/ CustomerChatbotAssistant", "description": "Chat \/ CustomerChatbotAssistant" }, { "name": "Chat \/ CustomerChatroom", "description": "Chat \/ CustomerChatroom" }, { "name": "Chat \/ CustomerChatroomMessage", "description": "Chat \/ CustomerChatroomMessage" }, { "name": "Chat \/ CustomerChatroomMember", "description": "Chat \/ CustomerChatroomMember" }, { "name": "Chat \/ CustomerChatroomMessageReactionController", "description": "Chat \/ CustomerChatroomMessageReactionController" }, { "name": "Chat \/ Chatroom", "description": "Chat \/ Chatroom" }, { "name": "Chat \/ ChatroomMessage", "description": "Chat \/ ChatroomMessage" }, { "name": "Chat \/ ChatroomMessageReport", "description": "Chat \/ ChatroomMessageReport" }, { "name": "Chat \/ ChatroomMessageReaction", "description": "Chat \/ ChatroomMessageReaction" }, { "name": "Chat \/ ChatroomParticipant", "description": "Chat \/ ChatroomParticipant" }, { "name": "Chat \/ ChatbotProfile", "description": "Chat \/ ChatbotProfile" }, { "name": "Chat \/ ChatbotConsent", "description": "Chat \/ ChatbotConsent" }, { "name": "CustomerPanel \/ AppUsageStatistics", "description": "CustomerPanel \/ AppUsageStatistics" }, { "name": "Chat \/ ChatbotTurnLog", "description": "Chat \/ ChatbotTurnLog" }, { "name": "Chat \/ ChatbotUsage", "description": "Chat \/ ChatbotUsage" }, { "name": "CRM \/ SubscriptionItem", "description": "CRM \/ SubscriptionItem" }, { "name": "CRM \/ EventAccessBudget", "description": "CRM \/ EventAccessBudget" }, { "name": "CRM \/ StudioTraining \/ StudioTrainingPersonData", "description": "CRM \/ StudioTraining \/ StudioTrainingPersonData" }, { "name": "CRM \/ StudioTraining \/ StudioTrainingPlan", "description": "CRM \/ StudioTraining \/ StudioTrainingPlan" }, { "name": "CRM \/ StudioTraining \/ StudioTrainingPreset", "description": "CRM \/ StudioTraining \/ StudioTrainingPreset" }, { "name": "CRM \/ StudioTraining \/ StudioDevice", "description": "CRM \/ StudioTraining \/ StudioDevice" }, { "name": "CRM \/ StudioTraining \/ StudioDeviceSetup", "description": "CRM \/ StudioTraining \/ StudioDeviceSetup" }, { "name": "CRM \/ StudioTraining \/ StudioTrainingMuscleGroup", "description": "CRM \/ StudioTraining \/ StudioTrainingMuscleGroup" }, { "name": "CRM \/ StudioTraining \/ StudioTrainingChallenge", "description": "CRM \/ StudioTraining \/ StudioTrainingChallenge" }, { "name": "CRM \/ StudioTraining \/ StudioTrainingPlanDay", "description": "CRM \/ StudioTraining \/ StudioTrainingPlanDay" }, { "name": "CRM \/ StudioTraining \/ StudioTrainingPlanExercise", "description": "CRM \/ StudioTraining \/ StudioTrainingPlanExercise" }, { "name": "CRM \/ StudioTraining \/ StudioTrainingSession", "description": "CRM \/ StudioTraining \/ StudioTrainingSession" }, { "name": "CRM \/ StudioTraining \/ StudioTrainingSessionEntry", "description": "CRM \/ StudioTraining \/ StudioTrainingSessionEntry" }, { "name": "CRM \/ StudioTraining \/ StudioTrainingMeasurement", "description": "CRM \/ StudioTraining \/ StudioTrainingMeasurement" }, { "name": "CRM \/ StudioTraining \/ Own", "description": "CRM \/ StudioTraining \/ Own" }, { "name": "CRM \/ StudioTraining \/ Actions", "description": "CRM \/ StudioTraining \/ Actions" }, { "name": "CRM \/ StudioTraining \/ Catalogue", "description": "CRM \/ StudioTraining \/ Catalogue" }, { "name": "CRM \/ Unified Categories", "description": "CRM \/ Unified Categories" }, { "name": "CRM \/ Unified Tags", "description": "CRM \/ Unified Tags" }, { "name": "CRM \/ PersonLogBookEntry", "description": "CRM \/ PersonLogBookEntry" }, { "name": "CRM \/ MembershipPauseRequest", "description": "CRM \/ MembershipPauseRequest" }, { "name": "CRM \/ PersonLogBookEntryType", "description": "CRM \/ PersonLogBookEntryType" }, { "name": "CRM \/ PersonLogBookEntryContentAddition", "description": "CRM \/ PersonLogBookEntryContentAddition" }, { "name": "CRM \/ Accounts | Companies", "description": "CRM \/ Accounts | Companies" }, { "name": "CRM \/ CRMDepartment", "description": "CRM \/ CRMDepartment" }, { "name": "CRM \/ CRMPerson", "description": "CRM \/ CRMPerson" }, { "name": "CRM \/ Actions", "description": "CRM \/ Actions" }, { "name": "CRM \/ CRMPersonContactData", "description": "CRM \/ CRMPersonContactData" }, { "name": "CRM \/ PersonDurationStatistic", "description": "CRM \/ PersonDurationStatistic" }, { "name": "CRM \/ General meeting (own)", "description": "CRM \/ General meeting (own)" }, { "name": "CRM \/ General meeting", "description": "CRM \/ General meeting" }, { "name": "CRM \/ PersonHonorAnniversary", "description": "CRM \/ PersonHonorAnniversary" }, { "name": "CRM \/ PersonSendNotification", "description": "CRM \/ PersonSendNotification" }, { "name": "CRM \/ CRMProject", "description": "CRM \/ CRMProject" }, { "name": "CRM \/ CRMProjectItem", "description": "CRM \/ CRMProjectItem" }, { "name": "CRM \/ CRMRecurrence", "description": "CRM \/ CRMRecurrence" }, { "name": "CRM \/ CRMProjectCategory", "description": "CRM \/ CRMProjectCategory" }, { "name": "CRM \/ CRMCompanyCategory", "description": "CRM \/ CRMCompanyCategory" }, { "name": "CRM \/ CRMPersonCategory", "description": "CRM \/ CRMPersonCategory" }, { "name": "CRM \/ CrmMessage", "description": "CRM \/ CrmMessage" }, { "name": "CRM \/ CRMTicket", "description": "CRM \/ CRMTicket" }, { "name": "CRM \/ CRMTicket \/ Sprints", "description": "CRM \/ CRMTicket \/ Sprints" }, { "name": "CRM \/ CRMTicketComment", "description": "CRM \/ CRMTicketComment" }, { "name": "CRM \/ Cancellation Terms", "description": "CRM \/ Cancellation Terms" }, { "name": "Billing \/ PaymentGoal", "description": "Billing \/ PaymentGoal" }, { "name": "Billing \/ PaymentType", "description": "Billing \/ PaymentType" }, { "name": "Billing \/ BillingPaymentProfile", "description": "Billing \/ BillingPaymentProfile" }, { "name": "Billing \/ BillingPayoutAccount", "description": "Billing \/ BillingPayoutAccount" }, { "name": "Billing \/ BillingDryRun", "description": "Billing \/ BillingDryRun" }, { "name": "Billing \/ Payment Gateway", "description": "Billing \/ Payment Gateway" }, { "name": "Billing \/ Invoice", "description": "Billing \/ Invoice" }, { "name": "Billing \/ ProformaInvoice", "description": "Billing \/ ProformaInvoice" }, { "name": "Billing \/ Tax", "description": "Billing \/ Tax" }, { "name": "Billing \/ AccountingType", "description": "Billing \/ AccountingType" }, { "name": "Billing \/ Offer", "description": "Billing \/ Offer" }, { "name": "Billing \/ PredefinedBillingItem", "description": "Billing \/ PredefinedBillingItem" }, { "name": "Billing \/ ProductLabel", "description": "Billing \/ ProductLabel" }, { "name": "Billing \/ BillingItemType", "description": "Billing \/ BillingItemType" }, { "name": "Billing \/ OfferAccountingType", "description": "Billing \/ OfferAccountingType" }, { "name": "Billing \/ ProjectTimeReport", "description": "Billing \/ ProjectTimeReport" }, { "name": "Billing \/ DonationGoal", "description": "Billing \/ DonationGoal" }, { "name": "Billing \/ Donation", "description": "Billing \/ Donation" }, { "name": "Billing \/ Donation Receipt", "description": "Billing \/ Donation Receipt" }, { "name": "Billing \/ RecurringDonation", "description": "Billing \/ RecurringDonation" }, { "name": "Billing \/ DonationExternal", "description": "Billing \/ DonationExternal" }, { "name": "Billing \/ Voucher", "description": "Billing \/ Voucher" }, { "name": "Billing \/ VoucherExternal", "description": "Billing \/ VoucherExternal" }, { "name": "Billing \/ InvoicePayment", "description": "Billing \/ InvoicePayment" }, { "name": "Billing \/ SepaPaymentTransaction", "description": "Billing \/ SepaPaymentTransaction" }, { "name": "Billing \/ PaymentTransaction", "description": "Billing \/ PaymentTransaction" }, { "name": "Billing \/ IncomingInvoiceTransaction", "description": "Billing \/ IncomingInvoiceTransaction" }, { "name": "Billing \/ ImportedPaymentTransaction", "description": "Billing \/ ImportedPaymentTransaction" }, { "name": "Billing \/ ImportedPaymentTransactionGroup", "description": "Billing \/ ImportedPaymentTransactionGroup" }, { "name": "Billing \/ IncomingInvoice", "description": "Billing \/ IncomingInvoice" }, { "name": "Billing \/ ExpenseCategory", "description": "Billing \/ ExpenseCategory" }, { "name": "Billing \/ E\u00dcR Report", "description": "Billing \/ E\u00dcR Report" }, { "name": "Billing \/ Anlageg\u00fcter", "description": "Billing \/ Anlageg\u00fcter" }, { "name": "Billing \/ Kassen", "description": "Billing \/ Kassen" }, { "name": "Billing \/ Kassenbuch", "description": "Billing \/ Kassenbuch" }, { "name": "Billing \/ Verbuchen", "description": "Billing \/ Verbuchen" }, { "name": "Billing \/ Umsatzsteuer", "description": "Billing \/ Umsatzsteuer" }, { "name": "Billing \/ Bilanzierung", "description": "Billing \/ Bilanzierung" }, { "name": "Billing \/ Kontenrahmen", "description": "Billing \/ Kontenrahmen" }, { "name": "Billing \/ AutoDunning", "description": "Billing \/ AutoDunning" }, { "name": "Billing \/ BillReminder", "description": "Billing \/ BillReminder" }, { "name": "Billing \/ Shipping", "description": "Billing \/ Shipping" }, { "name": "TimeTracking \/ EmploymentContract", "description": "TimeTracking \/ EmploymentContract" }, { "name": "TimeTracking \/ EmploymentContractTemplate", "description": "TimeTracking \/ EmploymentContractTemplate" }, { "name": "TimeTracking \/ TeamVacationPlanner", "description": "TimeTracking \/ TeamVacationPlanner" }, { "name": "TimeTracking \/ NonWorkTimeRequest", "description": "TimeTracking \/ NonWorkTimeRequest" }, { "name": "TimeTracking \/ VacationPlanningStatus", "description": "TimeTracking \/ VacationPlanningStatus" }, { "name": "TimeTracking \/ VacationCarryOverApproval", "description": "TimeTracking \/ VacationCarryOverApproval" }, { "name": "TimeTracking \/ VacationExpiryNotice", "description": "TimeTracking \/ VacationExpiryNotice" }, { "name": "TimeTracking \/ ShiftPlanEntry", "description": "TimeTracking \/ ShiftPlanEntry" }, { "name": "TimeTracking \/ ShiftPlanTemplate", "description": "TimeTracking \/ ShiftPlanTemplate" }, { "name": "TimeTracking \/ StaffingCoverageAlarm", "description": "TimeTracking \/ StaffingCoverageAlarm" }, { "name": "TimeTracking \/ StaffingRequirement", "description": "TimeTracking \/ StaffingRequirement" }, { "name": "TimeTracking \/ NonWorkTimeBlockingPeriod", "description": "TimeTracking \/ NonWorkTimeBlockingPeriod" }, { "name": "TimeTracking \/ NonWorkTimePlanSelectionType", "description": "TimeTracking \/ NonWorkTimePlanSelectionType" }, { "name": "TimeTracking \/ EmploymentContractChangeRequest", "description": "TimeTracking \/ EmploymentContractChangeRequest" }, { "name": "TimeTracking \/ EmploymentQualificationGroup", "description": "TimeTracking \/ EmploymentQualificationGroup" }, { "name": "TimeTracking \/ SchoolHolidayRegion", "description": "TimeTracking \/ SchoolHolidayRegion" }, { "name": "TimeTracking \/ OrganizationUnit", "description": "TimeTracking \/ OrganizationUnit" }, { "name": "TimeTracking \/ OrganizationBroadcast", "description": "TimeTracking \/ OrganizationBroadcast" }, { "name": "TimeTracking \/ ShiftType", "description": "TimeTracking \/ ShiftType" }, { "name": "TimeTracking \/ WorkTimeEntryCorrectionRequest", "description": "TimeTracking \/ WorkTimeEntryCorrectionRequest" }, { "name": "TimeTracking \/ ShiftExchangeRequest", "description": "TimeTracking \/ ShiftExchangeRequest" }, { "name": "TimeTracking \/ EmploymentQualification", "description": "TimeTracking \/ EmploymentQualification" }, { "name": "TimeTracking \/ ProcessedEmploymentContractMonth", "description": "TimeTracking \/ ProcessedEmploymentContractMonth" }, { "name": "TimeTracking \/ TrainerTimeEntry", "description": "TimeTracking \/ TrainerTimeEntry" }, { "name": "TimeTracking \/ TrainerTimeBilling", "description": "TimeTracking \/ TrainerTimeBilling" }, { "name": "TimeTracking \/ VolunteerHourEntry", "description": "TimeTracking \/ VolunteerHourEntry" }, { "name": "TimeTracking \/ VolunteerShift", "description": "TimeTracking \/ VolunteerShift" }, { "name": "TimeTracking \/ VolunteerShiftAssignment", "description": "TimeTracking \/ VolunteerShiftAssignment" }, { "name": "TimeTracking \/ VolunteerHourRequirement", "description": "TimeTracking \/ VolunteerHourRequirement" }, { "name": "TimeTracking \/ VolunteerHourSettlement", "description": "TimeTracking \/ VolunteerHourSettlement" }, { "name": "TimeTracking \/ Own volunteer hours", "description": "TimeTracking \/ Own volunteer hours" }, { "name": "TimeTracking \/ TrainerContract", "description": "TimeTracking \/ TrainerContract" }, { "name": "TimeTracking \/ TrainerQualification", "description": "TimeTracking \/ TrainerQualification" }, { "name": "TimeTracking \/ WorkTimeEntry", "description": "TimeTracking \/ WorkTimeEntry" }, { "name": "TimeTracking \/ NonWorkTimeAnnualRequest", "description": "TimeTracking \/ NonWorkTimeAnnualRequest" }, { "name": "TimeTracking \/ NonWorkTimeRequestComment", "description": "TimeTracking \/ NonWorkTimeRequestComment" }, { "name": "TimeTracking \/ EmployeeDocument", "description": "TimeTracking \/ EmployeeDocument" }, { "name": "TimeTracking \/ EmployeeDocumentComment", "description": "TimeTracking \/ EmployeeDocumentComment" }, { "name": "TimeTracking \/ EmployeeDocumentResponse", "description": "TimeTracking \/ EmployeeDocumentResponse" }, { "name": "ServerManagement \/ ShortLink", "description": "ServerManagement \/ ShortLink" }, { "name": "Server Management \/ iwmon", "description": "Server Management \/ iwmon" }, { "name": "Settings \/ AppWidget", "description": "Settings \/ AppWidget" }, { "name": "SoftwareManagement \/ Appcast", "description": "SoftwareManagement \/ Appcast" }, { "name": "Event \/ AttendanceList", "description": "Event \/ AttendanceList" }, { "name": "Event \/ AttendanceListEntry", "description": "Event \/ AttendanceListEntry" }, { "name": "Event \/ Moments", "description": "Event \/ Moments" }, { "name": "Event \/ Moments Public", "description": "Event \/ Moments Public" }, { "name": "Event \/ AttendanceListScanner", "description": "Event \/ AttendanceListScanner" }, { "name": "Event \/ EventSignUpScanner", "description": "Event \/ EventSignUpScanner" }, { "name": "Event \/ BaseLocation", "description": "Event \/ BaseLocation" }, { "name": "Event \/ BaseLocationPlan", "description": "Event \/ BaseLocationPlan" }, { "name": "Event \/ BaseLocationPlanItem", "description": "Event \/ BaseLocationPlanItem" }, { "name": "Event \/ BaseLocationPlan Status", "description": "Event \/ BaseLocationPlan Status" }, { "name": "Event \/ ContactCenter", "description": "Event \/ ContactCenter" }, { "name": "Event \/ BaseBookable", "description": "Event \/ BaseBookable" }, { "name": "DataWarehouse \/ SmartLock", "description": "DataWarehouse \/ SmartLock" }, { "name": "DataWarehouse \/ SmartLockConnection", "description": "DataWarehouse \/ SmartLockConnection" }, { "name": "DataWarehouse \/ SmartLockLog", "description": "DataWarehouse \/ SmartLockLog" }, { "name": "Event \/ External Display", "description": "Event \/ External Display" }, { "name": "Event \/ Kiosk Device", "description": "Event \/ Kiosk Device" }, { "name": "Event \/ Kiosk", "description": "Event \/ Kiosk" }, { "name": "Event \/ BaseBookableComponent", "description": "Event \/ BaseBookableComponent" }, { "name": "Event \/ BaseBookableUsageCounter", "description": "Event \/ BaseBookableUsageCounter" }, { "name": "Event \/ BaseBookingRealUsage", "description": "Event \/ BaseBookingRealUsage" }, { "name": "Event \/ BaseBookingRealUsageSection", "description": "Event \/ BaseBookingRealUsageSection" }, { "name": "Event \/ BookingContentType", "description": "Event \/ BookingContentType" }, { "name": "Event \/ BaseEventBibRange", "description": "Event \/ BaseEventBibRange" }, { "name": "Event \/ BibNumber", "description": "Event \/ BibNumber" }, { "name": "Event \/ Tickets", "description": "Event \/ Tickets" }, { "name": "Event \/ EventTimingPoint", "description": "Event \/ EventTimingPoint" }, { "name": "Event \/ EventTimingDevice", "description": "Event \/ EventTimingDevice" }, { "name": "Event \/ EventTimingRead", "description": "Event \/ EventTimingRead" }, { "name": "Event \/ EventScoreboardActivity", "description": "Event \/ EventScoreboardActivity" }, { "name": "Event \/ EventScoreboardTrainer", "description": "Event \/ EventScoreboardTrainer" }, { "name": "Event \/ EventTimingResult", "description": "Event \/ EventTimingResult" }, { "name": "Event \/ EventTimingDeviceApi", "description": "Event \/ EventTimingDeviceApi" }, { "name": "Event \/ EventTimingPublic", "description": "Event \/ EventTimingPublic" }, { "name": "Event \/ EventTimingCustomer", "description": "Event \/ EventTimingCustomer" }, { "name": "Event \/ BaseBookable Status", "description": "Event \/ BaseBookable Status" }, { "name": "Event \/ Event", "description": "Event \/ Event" }, { "name": "Event \/ Event Status", "description": "Event \/ Event Status" }, { "name": "Event \/ Event Schedule", "description": "Event \/ Event Schedule" }, { "name": "Event \/ BaseEventInvitation", "description": "Event \/ BaseEventInvitation" }, { "name": "Event \/ Booking", "description": "Event \/ Booking" }, { "name": "Event \/ Booking Status", "description": "Event \/ Booking Status" }, { "name": "Event \/ BookingGroup", "description": "Event \/ BookingGroup" }, { "name": "Event \/ EventSignUp", "description": "Event \/ EventSignUp" }, { "name": "Event \/ SignUpMembership", "description": "Event \/ SignUpMembership" }, { "name": "Event \/ Public", "description": "Event \/ Public" }, { "name": "Event \/ TrialPolicy (Schnupper-Regel)", "description": "Event \/ TrialPolicy (Schnupper-Regel)" }, { "name": "Event \/ Trial (Schnuppern)", "description": "Event \/ Trial (Schnuppern)" }, { "name": "Event \/ Age check", "description": "Event \/ Age check" }, { "name": "Event \/ Trainer substitution", "description": "Event \/ Trainer substitution" }, { "name": "Event \/ Booking substitution", "description": "Event \/ Booking substitution" }, { "name": "Event \/ Inventory loan", "description": "Event \/ Inventory loan" }, { "name": "Event \/ SignupDistribution", "description": "Event \/ SignupDistribution" }, { "name": "Event \/ SignupQuestionnaireSend", "description": "Event \/ SignupQuestionnaireSend" }, { "name": "Event \/ EventType", "description": "Event \/ EventType" }, { "name": "Event \/ BookableType", "description": "Event \/ BookableType" }, { "name": "Event \/ LocationType", "description": "Event \/ LocationType" }, { "name": "SipgateAPI \/ Call", "description": "SipgateAPI \/ Call" }, { "name": "OpenData \/ NACE Codes", "description": "OpenData \/ NACE Codes" }, { "name": "Social Login \/ Microsoft Login", "description": "Social Login \/ Microsoft Login" }, { "name": "Social Login \/ iw Remote ERP", "description": "Social Login \/ iw Remote ERP" }, { "name": "Social Login \/ Instagram Login", "description": "Social Login \/ Instagram Login" }, { "name": "Social Login \/ Facebook Login", "description": "Social Login \/ Facebook Login" }, { "name": "Social Login \/ Redirects", "description": "Social Login \/ Redirects" }, { "name": "OpenData \/ GeoCoding", "description": "OpenData \/ GeoCoding" }, { "name": "OpenData \/ IBAN", "description": "OpenData \/ IBAN" }, { "name": "OpenData \/ Calendar", "description": "OpenData \/ Calendar" }, { "name": "oAuth \/ Server Client", "description": "oAuth \/ Server Client" }, { "name": "oAuth \/ Server Client Permission", "description": "oAuth \/ Server Client Permission" }, { "name": "Media \/ Media Files", "description": "Media \/ Media Files" }, { "name": "Media \/ Media Groups", "description": "Media \/ Media Groups" }, { "name": "Media \/ News Article", "description": "Media \/ News Article" }, { "name": "Media \/ NewsArticleType", "description": "Media \/ NewsArticleType" }, { "name": "Helpcenter \/ Help Article", "description": "Helpcenter \/ Help Article" }, { "name": "Media \/ Article Space", "description": "Media \/ Article Space" }, { "name": "Media \/ MediaQuestionnaire", "description": "Media \/ MediaQuestionnaire" }, { "name": "Media \/ MediaQuestionnaire Answer", "description": "Media \/ MediaQuestionnaire Answer" }, { "name": "Media \/ Questionnaire Clarifications", "description": "Media \/ Questionnaire Clarifications" }, { "name": "Media \/ MediaQuestionnaire Answer Group", "description": "Media \/ MediaQuestionnaire Answer Group" }, { "name": "Media \/ MediaCardButton", "description": "Media \/ MediaCardButton" }, { "name": "Notification \/ MassNotification", "description": "Notification \/ MassNotification" }, { "name": "Notification \/ MessengerMessage", "description": "Notification \/ MessengerMessage" }, { "name": "Notification \/ Messenger", "description": "Notification \/ Messenger" }, { "name": "DataWarehouse \/ ImportFile", "description": "DataWarehouse \/ ImportFile" }, { "name": "DataWarehouse \/ Webhooks", "description": "DataWarehouse \/ Webhooks" }, { "name": "DataWarehouse \/ Search", "description": "DataWarehouse \/ Search" }, { "name": "Latex \/ FlexibleLatexTemplate", "description": "Latex \/ FlexibleLatexTemplate" }, { "name": "Settings \/ Screens", "description": "Settings \/ Screens" }, { "name": "Settings \/ Universal lists", "description": "Settings \/ Universal lists" }, { "name": "Settings \/ Settings", "description": "Settings \/ Settings" }, { "name": "TimeTracking \/ ExternalHr", "description": "TimeTracking \/ ExternalHr" }, { "name": "Settings \/ BuchhaltungsButler", "description": "Settings \/ BuchhaltungsButler" }, { "name": "Settings \/ AdditionalUiField", "description": "Settings \/ AdditionalUiField" }, { "name": "Settings \/ AdditionalUiFilter", "description": "Settings \/ AdditionalUiFilter" }, { "name": "Settings \/ DisabledUiFunction", "description": "Settings \/ DisabledUiFunction" }, { "name": "Settings \/ CronTask", "description": "Settings \/ CronTask" }, { "name": "Settings \/ MaintenanceCommand", "description": "Settings \/ MaintenanceCommand" }, { "name": "Settings \/ CustomerAppHomeWidgetDefault", "description": "Settings \/ CustomerAppHomeWidgetDefault" }, { "name": "Settings \/ CustomerAppMenuGroup", "description": "Settings \/ CustomerAppMenuGroup" }, { "name": "Settings \/ CustomerAppMenuItem", "description": "Settings \/ CustomerAppMenuItem" }, { "name": "Billing \/ TravelExpenseReport", "description": "Billing \/ TravelExpenseReport" }, { "name": "Billing \/ TravelExpenseType", "description": "Billing \/ TravelExpenseType" }, { "name": "Billing \/ TravelExpenseCountryRate", "description": "Billing \/ TravelExpenseCountryRate" }, { "name": "Billing \/ InventoryReport", "description": "Billing \/ InventoryReport" }, { "name": "Billing \/ InventoryReportItem", "description": "Billing \/ InventoryReportItem" }, { "name": "Billing \/ StorageLocation", "description": "Billing \/ StorageLocation" }, { "name": "Billing \/ HBCI", "description": "Billing \/ HBCI" }, { "name": "Media \/ Social Profiles", "description": "Media \/ Social Profiles" }, { "name": "Media \/ Social Posts", "description": "Media \/ Social Posts" }, { "name": "Media \/ Social Reports", "description": "Media \/ Social Reports" }, { "name": "Media \/ Social Post Comments", "description": "Media \/ Social Post Comments" }, { "name": "Media \/ Social Post Reactions", "description": "Media \/ Social Post Reactions" }, { "name": "Media \/ Social Post Comment Reactions", "description": "Media \/ Social Post Comment Reactions" }, { "name": "Media \/ Social Moderation Triggers", "description": "Media \/ Social Moderation Triggers" }, { "name": "Media \/ Feedback Status", "description": "Media \/ Feedback Status" }, { "name": "Media \/ Feedback Boards", "description": "Media \/ Feedback Boards" }, { "name": "Media \/ Feedback Entries", "description": "Media \/ Feedback Entries" }, { "name": "Media \/ Feedback Votes", "description": "Media \/ Feedback Votes" }, { "name": "Media \/ Feedback Subscriptions", "description": "Media \/ Feedback Subscriptions" }, { "name": "Media \/ Feedback Comments", "description": "Media \/ Feedback Comments" }, { "name": "Media \/ Feedback Roadmap", "description": "Media \/ Feedback Roadmap" }, { "name": "Media \/ Feedback Public", "description": "Media \/ Feedback Public" }, { "name": "DataWarehouse \/ HomeAssistant", "description": "DataWarehouse \/ HomeAssistant" }, { "name": "DataWarehouse \/ Node-RED", "description": "DataWarehouse \/ Node-RED" }, { "name": "DataWarehouse \/ N8n Webhooks", "description": "DataWarehouse \/ N8n Webhooks" }, { "name": "DataWarehouse \/ n8n", "description": "DataWarehouse \/ n8n" }, { "name": "Billing \/ Shopify", "description": "Billing \/ Shopify" } ] }